Assistants
Use these endpoints to manage assistants for your organization.Authentication & scope
- Header:
X-API-Key: YOUR_API_KEY - Read operations:
assistants:read - Write operations:
assistants:write
GET /v1/assistants
Returns assistants available to your organization.
Bash
Node
Python
200 OK
Common errors
403missingassistants:readscope404key/org context not found
POST /v1/assistants
Creates a new assistant. Body is DTO-accurate to NewCreateAssistantDTO.
Bash
Node
Python
201 Created
Common errors
400validation error (missing required fields)403missingassistants:writescope
GET /v1/assistants/{id}
Returns one assistant by id.
Bash
Node
Python
200 OK
Common errors
403missingassistants:readscope404assistant not found
PATCH /v1/assistants/{id}
Updates an assistant. Body is DTO-accurate to AISettingsDTO.
Bash
Node
Python
200 OK
Common errors
400validation error (missing required update fields)403missingassistants:writescope404assistant not found
Recommended integration flow
- Create an assistant with your base persona/instructions.
- Retrieve the assistant id.
- Use the assistant id when creating widget/call/workflow resources.
- Patch assistant settings as your use case evolves.