Import assistants from external provider

POST

/ai/assistants/import

Assistants

Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/ai/assistants/import' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key_ref": "string",
    "provider": "elevenlabs"
}'

Response Example

200 - Example 1

{
    "data": [
        {
            "created_at": "2019-08-24T14:15:22Z",
            "description": "string",
            "dynamic_variables": {},
            "dynamic_variables_webhook_url": "string",
            "enabled_features": [
                "telephony"
            ],
            "greeting": "string",
            "id": "string",
            "import_metadata": {
                "import_id": "string",
                "import_provider": "elevenlabs"
            },
            "insight_settings": {
                "insight_group_id": "string"
            },
            "instructions": "string",
            "llm_api_key_ref": "string",
            "messaging_settings": {
                "default_messaging_profile_id": "string",
                "delivery_status_webhook_url": "string"
            },
            "model": "string",
            "name": "string",
            "privacy_settings": {
                "data_retention": true
            },
            "telephony_settings": {
                "default_texml_app_id": "string"
            },
            "tools": [
                {
                    "type": "webhook",
                    "webhook": {
                        "body_parameters": {
                            "properties": {
                                "age": {
                                    "description": "The age of the customer.",
                                    "type": "integer"
                                },
                                "location": {
                                    "description": "The location of the customer.",
                                    "type": "string"
                                }
                            },
                            "required": [
                                "age",
                                "location"
                            ],
                            "type": "object"
                        },
                        "description": "string",
                        "headers": [
                            {
                                "name": "string",
                                "value": "string"
                            }
                        ],
                        "method": "POST",
                        "name": "string",
                        "path_parameters": {
                            "properties": {
                                "id": {
                                    "description": "The id of the customer.",
                                    "type": "string"
                                }
                            },
                            "required": [
                                "id"
                            ],
                            "type": "object"
                        },
                        "query_parameters": {
                            "properties": {
                                "page": {
                                    "description": "The page number.",
                                    "type": "integer"
                                }
                            },
                            "required": [
                                "page"
                            ],
                            "type": "object"
                        },
                        "url": "https://example.com/api/v1/function"
                    }
                }
            ],
            "transcription": {
                "language": "string",
                "model": "string"
            },
            "voice_settings": {
                "api_key_ref": "string",
                "voice": "string",
                "voice_speed": 1
            }
        }
    ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

api_key_ref

string

required

Integration secret pointer that refers to the API key for the external provider. This should be an identifier for an integration secret created via /v2/integration_secrets.

provider

enum<string>

required

The external provider to import assistants from.

Allowed values:

elevenlabsvapi

Examples

Responses

🟢200OK

application/json

Successful Response

Body

data

array[object (Assistant) {19}]

Data

required

created_at

string <date-time>

required

description

string

optional

dynamic_variables

object

optional

Map of dynamic variables and their values

dynamic_variables_webhook_url

string

optional

If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our guide for more information.

enabled_features

array[string]

Enabled Features

optional

Allowed values:

telephonymessaging

greeting

string

optional

Text that the assistant will use to start the conversation. This may be templated with dynamic variables

string

required

import_metadata

object (ImportMetadata)

optional

insight_settings

object (InsightSettings)

optional

instructions

string

required

System instructions for the assistant. These may be templated with dynamic variables

llm_api_key_ref

string

optional

This is only needed when using third-party inference providers. The identifier for an integration secret /v2/integration_secrets that refers to your LLM provider's API key. Warning: Free plans are unlikely to work with this integration.

messaging_settings

object (MessagingSettings)

optional

model

string

required

ID of the model to use. You can use the Get models API to see all of your available models,

name

string

required

privacy_settings

object (PrivacySettings)

optional

telephony_settings

object (TelephonySettings)

optional

tools

array [oneOf]

optional

The tools that the assistant can use. These may be templated with dynamic variables

transcription

object (TranscriptionSettings)

optional

voice_settings

object (VoiceSettings)

optional

🟠422Parameter Error

Modified at 2025-06-16 19:14:41

Create an assistant

Delete an assistant