Create agent

POST

agents

create

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Agent",
  "prompt": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "label": "My Prompt",
    "description": "This is a description",
    "content": "You are a helpful assistant...",
    "context_endpoint": "https://api.example.com/context",
    "collect_fields": [
      "<string>"
    ],
    "type": "prompt",
    "tags": [
      "tag1",
      "tag2"
    ],
    "prompt_template": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "required_context_keys": [
        "tag1",
        "tag2"
      ],
      "label": "My Prompt"
    }
  },
  "language": "en",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "action_transfer_call",
      "label": "Transfer Call",
      "description": "This is a description",
      "config": {},
      "action_trigger": {}
    }
  ],
  "voice": {},
  "initial_message": "Hello, how can I help you today?",
  "webhook": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "subscriptions": [
      "event_message",
      "event_action"
    ],
    "url": "https://example.com/webhook",
    "method": "POST",
    "label": "My Webhook",
    "description": "This is a description"
  },
  "interrupt_sensitivity": "low",
  "context_endpoint": "https://api.example.com/context",
  "noise_suppression": true,
  "endpointing_sensitivity": "auto",
  "ivr_navigation_mode": "default",
  "conversation_speed": 0.5,
  "initial_message_delay": 1000,
  "openai_model_name_override": "gpt-4",
  "ask_if_human_present_on_idle": true,
  "openai_account_connection": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "label": "My Account Connection",
    "description": "This is a description",
    "type": "account_connection_twilio",
    "credentials": {
      "twilio_account_sid": "AC1234567890",
      "twilio_auth_token": "1234567890"
    },
    "steering_pool": [
      "+1234567890"
    ],
    "account_supports_any_caller_id": false
  },
  "run_do_not_call_detection": true,
  "llm_fallback": {},
  "deepgram_keywords": {
    "kansas": "10"
  },
  "idle_time_seconds": 10,
  "llm_temperature": 0.5,
  "enable_recording": true,
  "provider": "openai",
  "model": "gpt-4",
  "label": "My Agent",
  "description": "This is a description",
  "transcriber": {},
  "call_duration_sec": 10,
  "max_idle_check_count": 10
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

prompt

object

required

prompt.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.label

string

Example:

"My Prompt"

prompt.description

string

Example:

"This is a description"

prompt.content

string

Example:

"You are a helpful assistant..."

prompt.context_endpoint

string

Example:

"https://api.example.com/context"

prompt.collect_fields

string[]

deprecated

prompt.type

enum<string>

Available options:

prompt,

block

Example:

"prompt"

prompt.tags

string[]

Example:

["tag1", "tag2"]

prompt.prompt_template

object

deprecated

prompt.prompt_template.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.prompt_template.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.prompt_template.required_context_keys

string[]

required

Example:

["tag1", "tag2"]

prompt.prompt_template.label

string

Example:

"My Prompt"

actions

object[]

required

voice

object

required

name

string

Example:

"My Agent"

language

enum<string>

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

initial_message

string

Example:

"Hello, how can I help you today?"

webhook

object

webhook.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

webhook.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

webhook.subscriptions

object[]

required

Example:

["event_message", "event_action"]

webhook.url

string

required

Example:

"https://example.com/webhook"

webhook.method

enum<string>

Available options:

GET,

POST

Example:

"POST"

webhook.label

string

Example:

"My Webhook"

webhook.description

string

Example:

"This is a description"

interrupt_sensitivity

enum<string>

Available options:

low,

high

context_endpoint

string

Example:

"https://api.example.com/context"

noise_suppression

boolean

Example:

true

endpointing_sensitivity

enum<string>

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

conversation_speed

number

Example:

0.5

initial_message_delay

number

Example:

1000

openai_model_name_override

string

Example:

"gpt-4"

ask_if_human_present_on_idle

boolean

Example:

true

run_do_not_call_detection

boolean

Example:

true

llm_fallback

object

deepgram_keywords

object

Example:

{ "kansas": "10" }

idle_time_seconds

number

Example:

10

llm_temperature

number

Example:

0.5

enable_recording

boolean

Example:

true

provider

string

Example:

"openai"

model

string

Example:

"gpt-4"

label

string

Example:

"My Agent"

description

string

Example:

"This is a description"

transcriber

object

call_duration_sec

number

Example:

10

max_idle_check_count

number

Example:

10

openai_account_connection

object

Response

201 - application/json

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt

object

required

prompt.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.label

string

Example:

"My Prompt"

prompt.description

string

Example:

"This is a description"

prompt.content

string

Example:

"You are a helpful assistant..."

prompt.context_endpoint

string

Example:

"https://api.example.com/context"

prompt.collect_fields

string[]

deprecated

prompt.type

enum<string>

Available options:

prompt,

block

Example:

"prompt"

prompt.tags

string[]

Example:

["tag1", "tag2"]

prompt.prompt_template

object

deprecated

prompt.prompt_template.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.prompt_template.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

prompt.prompt_template.required_context_keys

string[]

required

Example:

["tag1", "tag2"]

prompt.prompt_template.label

string

Example:

"My Prompt"

voice

object

required

name

string

Example:

"My Agent"

language

enum<string>

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

actions

object[]

initial_message

string

Example:

"Hello, how can I help you today?"

webhook

object

webhook.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

webhook.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

webhook.subscriptions

object[]

required

Example:

["event_message", "event_action"]

webhook.url

string

required

Example:

"https://example.com/webhook"

webhook.method

enum<string>

Available options:

GET,

POST

Example:

"POST"

webhook.label

string

Example:

"My Webhook"

webhook.description

string

Example:

"This is a description"

interrupt_sensitivity

enum<string>

Available options:

low,

high

context_endpoint

string

Example:

"https://api.example.com/context"

noise_suppression

boolean

Example:

true

endpointing_sensitivity

enum<string>

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

conversation_speed

number

Example:

0.5

initial_message_delay

number

Example:

1000

openai_model_name_override

string

Example:

"gpt-4"

ask_if_human_present_on_idle

boolean

Example:

true

openai_account_connection

object

openai_account_connection.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

openai_account_connection.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

openai_account_connection.type

enum<string>

required

Available options:

account_connection_twilio,

account_connection_openai,

account_connection_google,

account_connection_azure_llm,

account_connection_elevenlabs,

account_connection_deepgram,

account_connection_cartesia,

account_connection_playht,

account_connection_rime,

account_connection_azure_speech,

account_connection_assemblyai,

account_connection_deepseek,

account_connection_telnyx,

account_connection_un_pw_oauth,

account_connection_login_key_oauth,

account_connection_external_api_key

Example:

"account_connection_twilio"

openai_account_connection.credentials

object

required

Example:

{
  "twilio_account_sid": "AC1234567890",
  "twilio_auth_token": "1234567890"
}

openai_account_connection.label

string

Example:

"My Account Connection"

openai_account_connection.description

string

Example:

"This is a description"

openai_account_connection.steering_pool

string[]

Example:

["+1234567890"]

openai_account_connection.account_supports_any_caller_id

boolean

Example:

false

run_do_not_call_detection

boolean

Example:

true

llm_fallback

object

deepgram_keywords

object

Example:

{ "kansas": "10" }

idle_time_seconds

number

Example:

10

llm_temperature

number

Example:

0.5

enable_recording

boolean

Example:

true

provider

string

Example:

"openai"

model

string

Example:

"gpt-4"

label

string

Example:

"My Agent"

description

string

Example:

"This is a description"

transcriber

object

call_duration_sec

number

Example:

10

max_idle_check_count

number

Example:

10

List agents Update agent

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Agent",
  "prompt": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "label": "My Prompt",
    "description": "This is a description",
    "content": "You are a helpful assistant...",
    "context_endpoint": "https://api.example.com/context",
    "collect_fields": [
      "<string>"
    ],
    "type": "prompt",
    "tags": [
      "tag1",
      "tag2"
    ],
    "prompt_template": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "required_context_keys": [
        "tag1",
        "tag2"
      ],
      "label": "My Prompt"
    }
  },
  "language": "en",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "action_transfer_call",
      "label": "Transfer Call",
      "description": "This is a description",
      "config": {},
      "action_trigger": {}
    }
  ],
  "voice": {},
  "initial_message": "Hello, how can I help you today?",
  "webhook": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "subscriptions": [
      "event_message",
      "event_action"
    ],
    "url": "https://example.com/webhook",
    "method": "POST",
    "label": "My Webhook",
    "description": "This is a description"
  },
  "interrupt_sensitivity": "low",
  "context_endpoint": "https://api.example.com/context",
  "noise_suppression": true,
  "endpointing_sensitivity": "auto",
  "ivr_navigation_mode": "default",
  "conversation_speed": 0.5,
  "initial_message_delay": 1000,
  "openai_model_name_override": "gpt-4",
  "ask_if_human_present_on_idle": true,
  "openai_account_connection": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "label": "My Account Connection",
    "description": "This is a description",
    "type": "account_connection_twilio",
    "credentials": {
      "twilio_account_sid": "AC1234567890",
      "twilio_auth_token": "1234567890"
    },
    "steering_pool": [
      "+1234567890"
    ],
    "account_supports_any_caller_id": false
  },
  "run_do_not_call_detection": true,
  "llm_fallback": {},
  "deepgram_keywords": {
    "kansas": "10"
  },
  "idle_time_seconds": 10,
  "llm_temperature": 0.5,
  "enable_recording": true,
  "provider": "openai",
  "model": "gpt-4",
  "label": "My Agent",
  "description": "This is a description",
  "transcriber": {},
  "call_duration_sec": 10,
  "max_idle_check_count": 10
}

Account Connections

Numbers

Calls

Agents

Prompts

Voices

Actions

Webhooks

Authorizations

Body

Response