Skip to main content
GET
Get Assistant By Phone

Authorizations

Authorization
string
header
required

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

Path Parameters

phone_number
string
required

Response

Successful Response

Schema for assistant 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, anthropic, gemini, xai, groq, custom

llm_provider_config
LLMProviderConfig · object

Configuration for the selected LLM provider.

twilio_config
TwilioConfig · object

Twilio account configuration.

llm_settings
LLMSettings · object

Settings for the Large Language Model.

webhook_url
string | null
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
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.

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