Skip to content

List Agents

AgentListPage agents().list(params = AgentListParams.none())
GET/v1/agents

List agents owned by your organization, ordered from most recently created. The response includes an opaque cursor when another page is available.

Query parameters

All parameters are optional.

AgentListParams params
Optional<integer>limit

Number of agents to return. Accepts values from 1 to 100.

Default: 20

Optional<string>page

Opaque cursor returned in a previous response's next_page field.

Optional<boolean>include_archived

Include agents that have been archived.

Default: false

Optional<string · RFC 3339>created_at_gte

Return agents created at or after this timestamp.

Optional<string · RFC 3339>created_at_lte

Return agents created at or before this timestamp.

Pagination

Results are ordered by created_at descending. Pass next_page back as page; when next_page is absent, you have reached the final page.

Errors

400invalid_request

The page cursor or another query parameter is invalid.

401authentication_error

The API key is missing or invalid.