List agents

GET

agents

list

Copy
{
  "items": [
    {
      "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
    }
  ],
  "page": 123,
  "size": 123,
  "has_more": true,
  "total": 123,
  "total_is_estimated": true
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

number

size

number

sort_column

string

sort_desc

boolean

filters

string

Response

200

application/json

items

object[]

required

items.id

string

required

Example:

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

items.user_id

string

required

Example:

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

items.prompt

object

required

items.prompt.id

string

required

Example:

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

items.prompt.user_id

string

required

Example:

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

items.prompt.label

string

Example:

"My Prompt"

items.prompt.description

string

Example:

"This is a description"

items.prompt.content

string

Example:

"You are a helpful assistant..."

items.prompt.context_endpoint

string

Example:

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

items.prompt.collect_fields

string[]

deprecated

items.prompt.type

enum<string>

Available options:

prompt,

block

Example:

"prompt"

items.prompt.tags

string[]

Example:

["tag1", "tag2"]

items.prompt.prompt_template

object

deprecated

items.prompt.prompt_template.id

string

required

Example:

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

items.prompt.prompt_template.user_id

string

required

Example:

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

items.prompt.prompt_template.required_context_keys

string[]

required

Example:

["tag1", "tag2"]

items.prompt.prompt_template.label

string

Example:

"My Prompt"

items.voice

object

required

items.name

string

Example:

"My Agent"

items.language

enum<string>

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

items.actions

object[]

items.initial_message

string

Example:

"Hello, how can I help you today?"

items.webhook

object

items.webhook.id

string

required

Example:

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

items.webhook.user_id

string

required

Example:

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

items.webhook.subscriptions

object[]

required

Example:

["event_message", "event_action"]

items.webhook.url

string

required

Example:

"https://example.com/webhook"

items.webhook.method

enum<string>

Available options:

GET,

POST

Example:

"POST"

items.webhook.label

string

Example:

"My Webhook"

items.webhook.description

string

Example:

"This is a description"

items.interrupt_sensitivity

enum<string>

Available options:

low,

high

items.context_endpoint

string

Example:

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

items.noise_suppression

boolean

Example:

true

items.endpointing_sensitivity

enum<string>

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

items.conversation_speed

number

Example:

0.5

items.initial_message_delay

number

Example:

1000

items.openai_model_name_override

string

Example:

"gpt-4"

items.ask_if_human_present_on_idle

boolean

Example:

true

items.openai_account_connection

object

items.openai_account_connection.id

string

required

Example:

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

items.openai_account_connection.user_id

string

required

Example:

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

items.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"

items.openai_account_connection.credentials

object

required

Example:

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

items.openai_account_connection.label

string

Example:

"My Account Connection"

items.openai_account_connection.description

string

Example:

"This is a description"

items.openai_account_connection.steering_pool

string[]

Example:

["+1234567890"]

items.openai_account_connection.account_supports_any_caller_id

boolean

Example:

false

items.run_do_not_call_detection

boolean

Example:

true

items.llm_fallback

object

items.deepgram_keywords

object

Example:

{ "kansas": "10" }

items.idle_time_seconds

number

Example:

10

items.llm_temperature

number

Example:

0.5

items.enable_recording

boolean

Example:

true

items.provider

string

Example:

"openai"

items.model

string

Example:

"gpt-4"

items.label

string

Example:

"My Agent"

items.description

string

Example:

"This is a description"

items.transcriber

object

items.call_duration_sec

number

Example:

10

items.max_idle_check_count

number

Example:

10

page

number

required

size

number

required

has_more

boolean

required

total

number

required

total_is_estimated

boolean

required

Get agent Create agent

Copy
{
  "items": [
    {
      "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
    }
  ],
  "page": 123,
  "size": 123,
  "has_more": true,
  "total": 123,
  "total_is_estimated": true
}

Account Connections

Numbers

Calls

Agents

Prompts

Voices

Actions

Webhooks

Authorizations

Query Parameters

Response