Overview
Retrieve a paginated list of all AI agents in your workspace. This endpoint supports pagination and search, making it easy to browse or locate specific agents.Prerequisites
- Bearer token for an authenticated workspace
- Permission to access Agents
Request
string
required
Bearer token for authenticated workspace access.
integer
Page number for pagination. Default is
1.integer
Number of agents to return per page. Default is
10.string
Optional search term to filter agents by name.
Response
boolean
required
Indicates whether the request completed successfully.
integer
required
HTTP status code.
string
required
Human-readable success message.
array
required
List of AI agents available in the workspace.
integer
Current page number.
integer
Maximum number of records returned per page.
integer
Total number of available pages.
integer
Total number of AI agents in the workspace.
Error Handling
- 400 Bad Request – Invalid query parameters.
- 401 Unauthorized – Missing or invalid Bearer token.
- 403 Forbidden – You do not have permission to access agents.
- 500 Internal Server Error – Unexpected server error.
This endpoint supports pagination and search. If no search term is provided, all agents in the workspace are returned.
Use the returned Agent ID with:
GET /api/agents/{id}to retrieve complete agent details.PATCH /api/agents/{id}to update an agent.DELETE /api/agents/{id}to remove an agent.

