List AI assistants
Return the AI assistants of your organization, with optional filters and pagination.
Endpoint
GET/ai-assistants
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
assistant_type | string | No | conversation, support-ticket, helpdesk, ai-chat or voice. |
name | string | No | Exact name match. |
ai_model_id | integer | No | Assistants using this model. |
id | integer | No | Exact ID, or operators such as id[$ne]=123 or id[$in][]=1&id[$in][]=2. |
$limit | integer | No | Page size. Default 10, max 50. Use 0 to get only total. |
$skip | integer | No | Number of records to skip. |
$sort[field] | integer | No | 1 ascending, -1 descending, e.g. $sort[name]=1. |
$select[] | string | No | Return only these fields. |
Any other field of the AI assistant object can be used as an exact-match filter. Results are always limited to your API key's organization and exclude deleted assistants.
Request
Count voice assistants without loading them:
Response
json
Each item is a full AI assistant object; the example is shortened.
Report an issue with this documentation
Please log in to report issues with our documentation.