Create an assistant

POST 
/ai/assistants

Create a new AI Assistant.

application/json

Body

required

name Name (string)required
model Model (string)required
description Description (string)
instructions Instructions (string)required

tools

object[]

The function tool type follows the same schema as the OpenAI Assistants API. The retrieval tool type is unique to Telnyx. You may pass a list of embedded storage buckets for retrieval-augmented generation.

Array [

oneOf

• Function
• Retrieval

type stringrequired

Possible values: [function]

function

object

required

name stringrequired

description string

parameters object

type stringrequired

Possible values: [retrieval]

retrieval

object

required

bucket_ids string[]required

max_num_results integer

The maximum number of results to retrieve as context for the language model.

]

greeting Greeting (string)
llm_api_key_ref Llm Api Key Ref (string)

voice_settings

object

voice Voice (string)required

api_key_ref Api Key Ref (string)

transcription

object

model Model (string)

telephony_settings

object

default_texml_app_id Default Texml App Id (string)

messaging_settings

object

default_messaging_profile_id Default Messaging Profile Id (string)

delivery_status_webhook_url Delivery Status Webhook Url (string)
enabled_features EnabledFeatures (string)[]

Possible values: [telephony, messaging]

insight_settings

object

insight_group_id Insight Group Id (string)
dynamic_variables_webhook_url Dynamic Variables Webhook Url (string)
dynamic_variables object

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

id Id (string)required
name Name (string)required
created_at date-timerequired
description Description (string)
model Model (string)required
instructions Instructions (string)required

tools

object[]

Array [

oneOf

• Function
• Retrieval

type stringrequired

Possible values: [function]

function

object

required

name stringrequired

description string

parameters object

type stringrequired

Possible values: [retrieval]

retrieval

object

required

bucket_ids string[]required

max_num_results integer

The maximum number of results to retrieve as context for the language model.

]

greeting Greeting (string)
llm_api_key_ref Llm Api Key Ref (string)

voice_settings

object

voice Voice (string)required

api_key_ref Api Key Ref (string)

transcription

object

model Model (string)

telephony_settings

object

default_texml_app_id Default Texml App Id (string)

messaging_settings

object

default_messaging_profile_id Default Messaging Profile Id (string)

delivery_status_webhook_url Delivery Status Webhook Url (string)
enabled_features EnabledFeatures (string)[]

Possible values: [telephony, messaging]

insight_settings

object

insight_group_id Insight Group Id (string)
dynamic_variables_webhook_url Dynamic Variables Webhook Url (string)
dynamic_variables object

{
  "id": "string",
  "name": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "model": "string",
  "instructions": "string",
  "tools": [
    {},
    {}
  ],
  "greeting": "string",
  "llm_api_key_ref": "string",
  "voice_settings": {
    "voice": "string",
    "api_key_ref": "string"
  },
  "transcription": {
    "model": "string"
  },
  "telephony_settings": {
    "default_texml_app_id": "string"
  },
  "messaging_settings": {
    "default_messaging_profile_id": "string",
    "delivery_status_webhook_url": "string"
  },
  "enabled_features": [
    "telephony"
  ],
  "insight_settings": {
    "insight_group_id": "string"
  },
  "dynamic_variables_webhook_url": "string",
  "dynamic_variables": {}
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/assistants' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "model": "string",
  "description": "string",
  "instructions": "string",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "string",
        "description": "string",
        "parameters": {}
      }
    },
    {
      "type": "retrieval",
      "retrieval": {
        "bucket_ids": [
          "string"
        ],
        "max_num_results": 0
      }
    }
  ],
  "greeting": "string",
  "llm_api_key_ref": "string",
  "voice_settings": {
    "voice": "string",
    "api_key_ref": "string"
  },
  "transcription": {
    "model": "string"
  },
  "telephony_settings": {
    "default_texml_app_id": "string"
  },
  "messaging_settings": {
    "default_messaging_profile_id": "string",
    "delivery_status_webhook_url": "string"
  },
  "enabled_features": [
    "telephony"
  ],
  "insight_settings": {
    "insight_group_id": "string"
  },
  "dynamic_variables_webhook_url": "string",
  "dynamic_variables": {}
}'

Response samples

• 200
• 422

---

{
  "id": "string",
  "name": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "model": "string",
  "instructions": "string",
  "tools": [
    {},
    {}
  ],
  "greeting": "string",
  "llm_api_key_ref": "string",
  "voice_settings": {
    "voice": "string",
    "api_key_ref": "string"
  },
  "transcription": {
    "model": "string"
  },
  "telephony_settings": {
    "default_texml_app_id": "string"
  },
  "messaging_settings": {
    "default_messaging_profile_id": "string",
    "delivery_status_webhook_url": "string"
  },
  "enabled_features": [
    "telephony"
  ],
  "insight_settings": {
    "insight_group_id": "string"
  },
  "dynamic_variables_webhook_url": "string",
  "dynamic_variables": {}
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}