Skip to main content
GET
/
assistants
List Assistants
curl --request GET \
  --url https://api.staging.kathan.tech/assistants \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-ID: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "system_instruction": "<string>",
    "voice": {
      "voice_id": "<string>",
      "tts_provider": "cartesia",
      "tts_model": "sonic-3",
      "language": "en",
      "speed": 1
    },
    "llm": {
      "llm_provider": "google",
      "model": "gemini-1.5-flash"
    },
    "transcriber": {
      "stt_provider": "deepgram",
      "stt_model": "nova-3",
      "language": "en"
    },
    "speech_settings": {
      "style": "neutral",
      "responsiveness": "balanced",
      "interruptions": "on",
      "emotions": "natural"
    },
    "long_term_memory": {
      "enabled": false,
      "search_limit": 5,
      "search_threshold": 0.1,
      "system_prompt": "Relevant, user-specific context from previous conversations:\n\n"
    },
    "short_term_memory": {
      "enabled": false,
      "search_limit": 3
    },
    "call_summary": {
      "prompt": "<string>"
    },
    "recording": {
      "enabled": false,
      "stereo": true,
      "mp3_enabled": true
    },
    "call_actions": {
      "enabled": true,
      "allow_hangup": true,
      "allow_transfer": true,
      "hangup_triggers": [
        "<string>"
      ],
      "transfer_triggers": [
        "<string>"
      ],
      "transfer_number": "<string>",
      "transfer_mode": "cold",
      "confirm_required": true,
      "auto_hangup_silence_seconds": 123,
      "confirm_yes": [
        "<string>"
      ],
      "confirm_no": [
        "<string>"
      ],
      "webhook_url": "<string>",
      "webhook_timeout_ms": 3500
    },
    "description": "<string>",
    "first_message": "<string>",
    "knowledge_base_ids": [],
    "phone_number_id": "<string>",
    "assistant_speaks_first": true
  }
]

Authorizations

Authorization
string
header
required

API key authentication.

X-User-ID
string
header
required

Required user id for API key requests.

Response

Successful Response

id
string
required
name
string
required
system_instruction
string
required
voice
Voice · object
required
llm
Llm · object
required
transcriber
Transcriber · object
required
speech_settings
SpeechSettings · object
required
long_term_memory
LongTermMemoryConfig · object
required
short_term_memory
ShortTermMemoryConfig · object
required
call_summary
CallSummaryConfig · object
required
recording
RecordingSettings · object
required
call_actions
CallActionsConfig · object
required
description
string | null
first_message
string | null
knowledge_base_ids
string[]
phone_number_id
string | null
assistant_speaks_first
boolean | null