Skip to main content
GET
/
ai-assistants
cURL
curl --request GET \
  --url https://api.puretalk.ai/api/ai-assistants \
  --header 'X-API-KEY: <api-key>'
{
  "count": 100,
  "next": "https://api.puretalk.ai/api/ai-assistants/?page=2",
  "previous": "https://api.puretalk.ai/api/ai-assistants/?page=1",
  "results": [
    {
      "user": {
        "name": "<string>",
        "dp": "<string>",
        "email": "[email protected]"
      },
      "voice": {
        "voice_id": "<string>",
        "name": "<string>",
        "avatar": "<string>",
        "gender": "<string>",
        "demo_audio_url": "<string>",
        "is_cloned": true,
        "language": "<string>",
        "description": "<string>"
      },
      "llm_states": [
        "<unknown>"
      ],
      "phone_number": "<string>",
      "variables": [
        "<unknown>"
      ],
      "knowledge_base": "<string>",
      "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "prompt": "<string>",
      "model": "<string>",
      "who_speaks_first": "assistant",
      "begin_message": "<string>",
      "assistant_type": "<string>",
      "avatar": "<string>",
      "custom_knowledge_base": "<string>",
      "timezone": "<string>",
      "voice_stability": 0.5,
      "voice_clarity_similarity": 0.5,
      "voice_stream_latency_optimization": 2,
      "voice_boost": true,
      "voice_speed": 123,
      "voice_emotion": [
        "<unknown>"
      ],
      "call_recording_enabled": true,
      "reminder_message_frequency": 123,
      "max_reminder_messages": 123,
      "post_analysis": "<string>",
      "chatbot_logo": "<string>",
      "chatbot_accent_color": "<string>",
      "chatbot_faq": "<string>",
      "chatbot_whitelisted_domains": [
        "<string>"
      ],
      "chatbot_begin_message": "<string>",
      "tools": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "behavior": 123
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.

Query Parameters

page
integer<int32>

The page number to return

limit
integer<int32>

The maximum number of results to return

Response

AI Assistants response

count
integer

The total number of AI Assistants

Example:

100

next
string | null

The next page of AI Assistants

Example:

"https://api.puretalk.ai/api/ai-assistants/?page=2"

previous
string | null

The previous page of AI Assistants

Example:

"https://api.puretalk.ai/api/ai-assistants/?page=1"

results
object[]

The list of AI Assistants