Get Assistant

GET

api

vendors

{vendorId}

organizations

{organizationId}

assistants

{assistantId}

Get Assistant Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Help Desk Assistant",
    "systemPrompt": "You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary.",
    "llmAudioContentGenerationStrategyId": "abcdef01-2345-6789-abcd-ef0123456789",
    "extensions": [
      {
        "id": "deadbeef-cafe-babe-feed-faceabadb001",
        "name": "Knowledge Base Search",
        "type": "kb_search_v2",
        "parameters": {
          "kb_url": "https://kb.example.com/api",
          "max_results": 3,
          "auth_token": null
        }
      }
    ],
    "callEventHooks": [
      {
        "id": "b00bface-1337-badd-cafe-d00df00dcafe",
        "type": "webhook_transcript_ready_v1",
        "parameters": {
          "target_url": "https://my.internal.service/transcript",
          "secret_key": "s3cr3t_tr4nscr1pt"
        }
      }
    ],
    "systemPromptGreeting": "Hello! How can I help you with our products today?",
    "telephoneNumberId": "11223344-5566-7788-9900-aabbccddeeff"
  },
  "traceId": "<string>"
}

Path Parameters

vendorId

string

required

ID of the Vendor (UUID)

organizationId

string

required

ID of the Organization (UUID)

assistantId

string

required

ID of the Assistant (UUID)

Response

Successfully retrieved assistant details

Standard API response wrapper

success

boolean

required

Indicates if the request was successful

Example:

true

timestamp

string<date-time>

required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

message

string

Human-readable message

data

object

Payload data object

Show child attributes

data.id

string

required

Unique identifier of the assistant (UUID).

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.name

string

required

Name of the assistant.

Example:

"Help Desk Assistant"

data.systemPrompt

string

required

Main system prompt defining the assistant's role and behavior.

Example:

"You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary."

data.llmAudioContentGenerationStrategyId

string

required

ID of the LLM Audio Content Generation Strategy used by the assistant (UUID).

Example:

"abcdef01-2345-6789-abcd-ef0123456789"

data.extensions

object[]

required

List of LLM extensions configured for this assistant.

Show child attributes

data.extensions.id

string

required

Unique identifier of the LLM extension instance (UUID).

Example:

"deadbeef-cafe-babe-feed-faceabadb001"

data.extensions.name

string

required

Name of the LLM extension.

Example:

"Knowledge Base Search"

data.extensions.type

string

required

Type identifier for the LLM extension.

Example:

"kb_search_v2"

data.extensions.parameters

object

required

Specific parameters for this extension instance (structure depends on the extension type). Null values may be present.

Show child attributes

data.extensions.parameters.{key}

object

Example:

{
  "kb_url": "https://kb.example.com/api",
  "max_results": 3,
  "auth_token": null
}

data.callEventHooks

object[]

required

List of Call Event Hooks configured for this assistant.

Show child attributes

data.callEventHooks.id

string

required

Unique identifier of the call event hook instance (UUID).

Example:

"b00bface-1337-badd-cafe-d00df00dcafe"

data.callEventHooks.type

string

required

Type identifier for the call event hook.

Example:

"webhook_transcript_ready_v1"

data.callEventHooks.parameters

object

required

Specific parameters for this hook instance (structure depends on the hook type).

Show child attributes

data.callEventHooks.parameters.{key}

string

Example:

{
  "target_url": "https://my.internal.service/transcript",
  "secret_key": "s3cr3t_tr4nscr1pt"
}

data.systemPromptGreeting

string

required

Initial greeting message from the assistant.

Example:

"Hello! How can I help you with our products today?"

data.telephoneNumberId

string

ID of the telephone number assigned to this assistant (UUID).

Example:

"11223344-5566-7788-9900-aabbccddeeff"

traceId

string

Correlation or trace ID

Update AssistantUpdates an existing assistant's configuration. Allows updating details, extensions, and call event hooks. Extensions and hooks can be modified or added (if ID is provided for update, null/missing for creation within the list).

⌘I

Get Assistant Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Help Desk Assistant",
    "systemPrompt": "You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary.",
    "llmAudioContentGenerationStrategyId": "abcdef01-2345-6789-abcd-ef0123456789",
    "extensions": [
      {
        "id": "deadbeef-cafe-babe-feed-faceabadb001",
        "name": "Knowledge Base Search",
        "type": "kb_search_v2",
        "parameters": {
          "kb_url": "https://kb.example.com/api",
          "max_results": 3,
          "auth_token": null
        }
      }
    ],
    "callEventHooks": [
      {
        "id": "b00bface-1337-badd-cafe-d00df00dcafe",
        "type": "webhook_transcript_ready_v1",
        "parameters": {
          "target_url": "https://my.internal.service/transcript",
          "secret_key": "s3cr3t_tr4nscr1pt"
        }
      }
    ],
    "systemPromptGreeting": "Hello! How can I help you with our products today?",
    "telephoneNumberId": "11223344-5566-7788-9900-aabbccddeeff"
  },
  "traceId": "<string>"
}

Overview

Realtime

Assistants

Agents

Agent Tasks

Organizations

Plans

Vendors

Path Parameters

Response