Skip to main content
POST
List assistants
Returns the assistants in the workspace your API key belongs to, most recently edited first.
This read is a POST because a list query is a document: page, size and search arrive typed as themselves instead of being coerced from a query string. It changes nothing.

Body

number
default:"1"
1-based page number. Pass back pagination.next_cursor from the previous response.
number
default:"10"
Page size, between 1 and 100.
Case-insensitive substring of agent_name.

Request

Response

200 OK. Standard envelope plus pagination — see Responses. next_cursor is the next page number, or null on the last page. Stop there: a page past the last one is not an empty list. It answers 500 INTERNAL_ERROR, and sending it again does not help.
object
required
A two-key extract, not the assistant’s configuration: systemPrompt and voice only. The full document is every tool definition, analysis field and widget setting — too much to ship twenty of. Fetch one assistant for the whole thing.
string | null
required
The number routed to this assistant for incoming calls, if any.
string | null
required
The number this assistant places calls from, if any.

Paging through every assistant