API REFERENCE
Assistants
Manage your AI entities. Assistants are the brains behind your calls, defined by their system prompts, voice settings, and model configurations. They can be assigned to campaigns to handle automated interactions.
List all assistants
GEThttp://localhost:3000/api/assistants
Returns a list of all AI assistants configured in your account.
Responses
JSON
Create a new assistant
POSThttp://localhost:3000/api/assistants
Creates a new AI assistant. You can specify the model, system prompt, voice, and first message.
Body Parameters
| Field | Type | Description |
|---|---|---|
| name * | string | Internal name for the assistant. |
| model * | string | AI model ID (e.g. "gpt-4", "claude-3"). |
| prompt * | string | The system instructions defining the assistant behavior. |
| voice | string | Voice ID for text-to-speech. |
| firstMessage | string | The opening line said by the assistant. |
Responses
JSON
Get an assistant
GEThttp://localhost:3000/api/assistants/{uuid}
Retrieves the full configuration of a specific assistant.
Responses
JSON
Update an assistant
PATCHhttp://localhost:3000/api/assistants/{uuid}
Updates the settings of an existing assistant, such as modifying the prompt or changing the voice.
Body Parameters
| Field | Type | Description |
|---|---|---|
| name | string | Update the name. |
| prompt | string | Update the instructions. |
| voice | string | Change the voice. |
Responses
JSON
Delete an assistant
DELETEhttp://localhost:3000/api/assistants/{uuid}
Permanently deletes an assistant. This action will fail if the assistant is currently assigned to active campaigns.
Responses
// 204 No Content