List agents
GET /api/v1/agents
List agents owned by the authenticated organization. Specify projectId for a single Project. Sessions must specify organizationId when listing Agents across Projects. Organization-scoped credentials may omit both.
Query Parameters
filter: Filter by Agent name or slug (partial match, case-insensitive)limit: Maximum results (default 20)cursor: Opaque cursor returned inpagination.nextCursor.
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
filter | string | optional | Filters agents using the server-side agent search expression. Applies to List agents. |
projectId | string | optional | Filters results to the specified Project. Applies to List agents. |
organizationId | string | optional | Selects the organization for the Agent list. Required for sessions when projectId is omitted. Omit when selecting a single Project. |
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List agents. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List agents. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — agents: array<one of 2 types> (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |