Endpoints

Managing assistants

Standard listing and CRUD. Creating writes the assistant to the live voice platform first, then mirrors it locally; the optional selected_phone_number purchases and attaches a number in the same request. Updating re-renders the prompt from the stored template, metadata and variables.

Advanced editor

The advanced endpoints expose the full configuration surface (analysis, artifacts, notifications, personality switching) on top of the regular fields. The GET returns the merged live configuration; the PUT accepts everything the regular update accepts plus the extra fields listed on the Fields page.

Embed widget

Each assistant can be embedded as a website chat/voice widget. These endpoints read and write the widget configuration and return ready-to-paste embed HTML.

Statistics and version history

Call statistics power the dashboard graphs. The version history journal records configuration changes; any entry can be restored, which re-applies that configuration to the live assistant.

GET/assistants

List assistants you can access

Parameters

Response example 200

{
  "success": true,
  "data": [{"id": 12, "assistant_id": "a1b2c3d4-…", "name": "Reception", "type": "production", "phone_number": "+15551230000", "first_message": "…"}],
  "pagination": {"current_page": 1, "last_page": 1, "per_page": 9, "total": 3, "from": 1, "to": 3}
}

Errors

POST/assistants

Create an assistant (writes to the live voice platform)

Parameters

Request example

{
  "name": "Reception",
  "type": "production",
  "template_id": 5,
  "firstMessage": "Thank you for calling, how can I help?",
  "metadata": {"company_name": "Acme Dental", "industry": "Dental"}
}

Response example 201

{"success": true, "data": {"id": 12, "assistant_id": "a1b2c3d4-…", "name": "Reception", …}, "message": "Assistant created successfully"}

Errors

Notes

• Validation messages include: "Assistant name is required.", "Assistant name cannot exceed 40 characters.", "Type must be either demo or production.", "Phone number must be in international format (e.g., +1234567890)."
• user_id is honoured only when the caller is an admin.

GET/assistants/{assistantId}

Retrieve one assistant

Parameters

Response example 200

{"success": true, "data": {"id": 12, "assistant_id": "a1b2c3d4-…", "name": "Reception", "type": "production", "first_message": "…", "metadata": { … }, …}}

Errors

PUT/assistants/{assistantId}

Update an assistant (re-renders the prompt, syncs live)

Parameters

Request example

{"firstMessage": "Hello! You have reached Acme Dental.", "metadata": {"business_hours": "Mon–Fri 9–5"}}

Response example 200

{"success": true, "data": { … }, "message": "Assistant updated successfully"}

Errors

DELETE/assistants/{assistantId}

Delete an assistant from the system and the live platform

Parameters

Response example 200

{"success": true, "message": "Assistant deleted successfully"}

Errors

GET/assistants/{assistantId}/stats

Call statistics for the dashboard

Parameters

Errors

Notes

• Returns an aggregate statistics object for dashboard graphs; its exact shape is internal and may evolve.

GET/assistants/tools

Tools available to attach to an assistant

Parameters

Response example 200

{
  "success": true,
  "data": [{"value": "c3d4e5f6-…", "label": "Book appointment", "description": "…", "type": "function", "scope": "own", "locked": false}],
  "locked_tool_ids": ["…"]
}

Errors

Notes

• Global (platform) tools sort first with scope "global". locked entries cannot be detached.

GET/assistants/{assistantId}/advanced

Full merged configuration for the advanced editor

Parameters

Errors

Notes

• Returns the assistant row plus the merged live configuration; the raw greeting/end-call text is preferred over rendered versions.

PUT/assistants/{assistantId}/advanced

Update everything — regular fields plus the advanced set

Parameters

Response example 200

{"success": true, "message": "Assistant updated successfully", "data": { … }}

Errors

Notes

• The live platform is updated first; the local mirror only saves when that succeeds — the two can never diverge silently.

GET/assistants/{assistantId}/embed

Embed widget configuration + ready-to-paste HTML

Parameters

Response example 200

{"success": true, "data": {"assistant_id": "a1b2c3d4-…", "embed_config": { … }, "public_key": "…", "widget_script_url": "…", "api_url": "…", "embed_html": "<script …>"}}

Errors

PUT/assistants/{assistantId}/embed

Save the widget configuration

Parameters

Response example 200

{"success": true, "data": {"assistant_id": "a1b2c3d4-…", "embed_config": { … }, "public_key": "…", "embed_html": "…"}}

Errors

GET/assistants/prompt-templates/by-industry

Active prompt templates, optionally filtered by industry

Parameters

Response example 200

{"success": true, "data": [{"id": 5, "name": "General Receptionist", "description": "…", "custom_fields": [], "is_default": true, "assistant_roles": [{"id": 1, "name": "Receptionist", "slug": "receptionist"}]}]}

Errors

GET/assistants/{assistantId}/update-log

Configuration version history

Parameters

Response example 200

{"success": true, "data": [ …history entries… ], "meta": {"limit": 20, "offset": 0, "returned": 8}}

Errors

Notes

• meta also carries an availability flag; when history storage is not configured the endpoint returns an empty data list.

POST/assistants/{assistantId}/update-log/{entryId}/restore

Restore a configuration from the version history

Parameters

Response example 200

{"success": true, "message": "Assistant restored successfully", "data": { … }}

Errors