ApiAssistants

Get an assistant

GET
/assistants/{id}

Retrieve a specific assistant by ID.

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Path Parameters

id*string

Assistant UUID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/assistants/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "assistant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Customer Support Agent",
    "business_name": "Acme Corp",
    "notification_email": "support@acme.com",
    "first_message": "Hello, welcome to Acme. How can I help you today?",
    "is_active": true,
    "autonomous_silence_handling": true,
    "silence_timeout_seconds": 8,
    "max_duration_seconds": 1800,
    "voicemail_detection": true,
    "voicemail_message": "Hello, this is Acme Corp. We will call you back at a later time. Thank you!",
    "gdpr_mode": false,
    "webhook_url": "http://example.com",
    "webhook_secret": "string",
    "webhook_events": [
      "string"
    ],
    "analysis_plan": {
      "structured_data_plan": {
        "enabled": true,
        "schema": {
          "type": "object",
          "properties": {
            "intent": {
              "type": "string"
            },
            "sentiment": {
              "type": "string",
              "enum": [
                "positive",
                "neutral",
                "negative"
              ]
            },
            "appointment_booked": {
              "type": "boolean"
            }
          }
        },
        "messages": [
          {
            "role": "system",
            "content": "Analyze the following call transcript according to this schema: {{schema}}"
          }
        ]
      },
      "min_messages_threshold": 5
    },
    "stt_config": {
      "provider": "deepgram",
      "model": "nova-3",
      "language": "en",
      "keyterms": [
        "Acme",
        "VoiceDock"
      ]
    },
    "llm_config": {
      "provider": "openai",
      "model": "gpt-5.4",
      "temperature": 0.7,
      "messages": [
        {
          "role": "system",
          "content": "string"
        }
      ],
      "tools": [
        {
          "name": "lookup_contact",
          "description": "Look up contact information by name or phone number",
          "url": "https://n8n.example.com/webhook/contacts",
          "async": false,
          "parameters": {
            "type": "object",
            "properties": {
              "query": {
                "type": "string",
                "description": "Name or phone number to search"
              }
            },
            "required": [
              "query"
            ]
          }
        }
      ]
    },
    "tts_config": {
      "provider": "elevenlabs",
      "voice_id": "voice-id",
      "model": "eleven_flash_v2_5",
      "stability": 0.5,
      "similarity_boost": 0.75,
      "style": 0,
      "use_speaker_boost": true,
      "speed": 1
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "Invalid API key",
  "message": "string"
}
{
  "error": "Invalid API key",
  "message": "string"
}