GET
/
api
/
v1
/
assistants
[
  {
    "name": "<string>",
    "description": "<string>",
    "llm_provider": "<string>",
    "llm_provider_config": {
      "api_key": "<string>",
      "base_url": "<string>",
      "model": "gpt-4o-mini",
      "custom_config": {}
    },
    "twilio_config": {
      "account_sid": "<string>",
      "auth_token": "<string>"
    },
    "llm_settings": {
      "temperature": 0.5,
      "max_tokens": 1000,
      "system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
      "welcome_message": "<string>",
      "top_p": 1,
      "frequency_penalty": 0,
      "presence_penalty": 0,
      "stop_sequences": [
        "<string>"
      ]
    },
    "webhook_url": "<string>",
    "interruption_settings": {
      "interruption_threshold": 3,
      "min_speaking_time": 0.5,
      "interruption_cooldown": 2
    },
    "tts_settings": {
      "provider": "elevenlabs",
      "voice_id": "rachel",
      "model_id": "<string>",
      "latency": 1,
      "stability": 0.5,
      "similarity_boost": 0.75,
      "style": 0,
      "use_speaker_boost": true,
      "provider_config": {}
    },
    "stt_settings": {
      "model": "nova-2",
      "language": "en-US",
      "punctuate": true,
      "interim_results": true,
      "endpointing": {
        "silence_threshold": 500,
        "min_silence_duration": 500
      },
      "utterance_end_ms": 1000,
      "vad_turnoff": 500,
      "smart_format": true,
      "keywords": [
        {
          "keyword": "<string>",
          "intensifier": 1
        }
      ],
      "keyterms": [
        "<string>"
      ],
      "audio_denoising": false
    },
    "end_call_message": "<string>",
    "transfer_call_message": "<string>",
    "idle_message": "<string>",
    "max_idle_messages": 123,
    "idle_timeout": 123,
    "tools_settings": {
      "enabled_tools": [
        "<string>"
      ],
      "end_call": {
        "enabled": false,
        "scenarios": [
          "<string>"
        ],
        "custom_message": "<string>"
      },
      "transfer_call": {
        "enabled": false,
        "scenarios": [
          "<string>"
        ],
        "transfer_numbers": [
          "<string>"
        ],
        "custom_message": "<string>"
      },
      "custom_tools": [
        {}
      ]
    },
    "rag_settings": {
      "enabled": false,
      "search_limit": 3,
      "similarity_threshold": 0.7,
      "embedding_model": "text-embedding-3-small",
      "chunking_strategy": "recursive",
      "chunk_size": 1000,
      "chunk_overlap": 200,
      "auto_process": true,
      "include_metadata": true,
      "context_window_tokens": 4000
    },
    "llm_fallback_providers": {
      "enabled": false,
      "fallbacks": [
        {
          "provider": "<string>",
          "api_key": "<string>",
          "base_url": "<string>",
          "model": "<string>"
        }
      ]
    },
    "custom_settings": {},
    "is_active": true,
    "id": 123,
    "organization_id": 123,
    "user_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]
This endpoint retrieves a list of all assistants belonging to your organization. The results are paginated to make handling large numbers of assistants easier.

​
Query Parameters

  • skip (integer, optional, default: 0): The number of assistants to skip before starting to collect the result set.
  • limit (integer, optional, default: 100): The maximum number of assistants to return.

​
Response

The response is a JSON array where each object represents an assistant, containing its full configuration details.
Response
[
  {
    "id": "asst_a1b2c3d4e5f67890",
    "user_id": "user_12345",
    "organization_id": "org_67890",
    "name": "Customer Service Bot",
    "description": "Handles inbound customer queries and provides support.",
    "is_active": true,
    "llm_settings": {
      "provider": "openai",
      "model": "gpt-4-turbo",
      "temperature": 0.7,
      "max_tokens": 250
    },
    "tts_settings": {
      "provider": "elevenlabs",
      "voice_id": "EXAVITQu4vr4xnSDxMaL",
      "stability": 0.5,
      "similarity_boost": 0.75
    },
    "stt_settings": {
      "provider": "deepgram",
      "language": "en-US",
      "model": "nova-2"
    },
    "interruption_settings": {
      "enabled": true,
      "threshold": 0.5,
      "evaluation_period": 0.8
    },
    "tools_settings": {
      "end_call": {
        "enabled": true,
        "scenarios": ["The user says goodbye.", "The issue is fully resolved."]
      },
      "transfer_call": {
        "enabled": false
      }
    },
    "created_at": "2023-10-26T10:00:00Z",
    "updated_at": "2023-10-26T10:00:00Z"
  }
]

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

Response

200
application/json

Successful Response

The response is of type AssistantResponse · object[].