Skip to main content
GET

Authorizations

Authorization
string
header
required

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

Query Parameters

skip
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
active_only
boolean
default:false

Only return active assistants

my_assistants_only
boolean
default:false

Only return assistants created by me

include_stats
boolean
default:false

Include call statistics

Response

Successful Response

name
string
required
id
integer
required
organization_id
integer
required
user_id
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
llm_provider
string | null
default:openai

LLM provider: openai, azure, anthropic, gemini, xai, groq, custom

llm_provider_config
LLMProviderConfig · object

Configuration for the selected LLM provider.

llm_settings
LLMSettings · object

Settings for the Large Language Model.

webhook_url
string | null
sms_webhook_url
string | null

URL to receive SMS webhook events

messaging_service_sid
string | null

Twilio Messaging Service SID for SMS handling

interruption_settings
InterruptionSettings · object

Settings for call interruption behavior.

tts_settings
TTSSettings · object

Settings for Text-to-Speech (TTS) service.

stt_settings
STTSettings · object

Settings for Speech-to-Text (STT) service.

end_call_message
string | null
transfer_call_message
string | null
idle_message
string | null
default:Are you still there? I'm here to help if you need anything.
max_idle_messages
integer | null
idle_timeout
integer | null
max_call_length
integer | null

Maximum call length in seconds. Calls will be automatically ended when this limit is reached. None means unlimited.

Required range: x >= 1
conversation_continuity_enabled
boolean | null
default:true

Enable conversation history continuity across calls from same number within 15 minutes

tools_settings
ToolsSettings · object

Settings for integrated tools.

rag_settings
RAGSettings · object

Settings for Retrieval-Augmented Generation (RAG).

llm_fallback_providers
LLMFallbackSettings · object

Settings for LLM fallback providers.

bypass_numbers
string[] | null

Phone numbers in E.164 format (e.g. +12345678900) that bypass AI and transfer directly to the configured transfer number

custom_settings
Custom Settings · object | null
is_active
boolean | null
default:true
backchannel_settings
BackchannelGenerationSettings · object | null

AI backchannel generation settings for active listening cues

recording_settings
RecordingSettings · object | null

Recording settings including enabled flag and disclosure options

api_keys
Api Keys · object | null

Assistant-specific API keys (overrides organization keys). Keys: elevenlabs_api_key, deepgram_api_key, cartesia_api_key, etc.

tts_limit
integer | null

TTS slot limit for this assistant (only used if assistant has own TTS key)

Required range: 1 <= x <= 1000
stt_limit
integer | null

STT slot limit for this assistant (only used if assistant has own STT key)

Required range: 1 <= x <= 1000
total_calls
integer | null

Total number of calls for this assistant

avg_call_duration
integer | null

Average call duration in seconds

success_rate
number | null

Success rate percentage