List Agents

Retrieve a paginated list of agents for your project. Optionally filter by name.

page_size defaults to 30, maximum 100.

GET /api/v2/projects/{project_id}/agents

List Agents

cURL

curl --request GET \
  --url https://api.example.com/api/v2/projects/{project_id}/agents \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "has_next": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id · string · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 30

name · string | null

Response

200 - application/json

GetAgentsResponsePayload(data: list[server.api_routes.agents_api_v2.AgentInfo], pagination: server.api_routes.api_v2_common.PaginationInfo)

data · AgentInfo · object[] · required

Show child attributes

pagination · PaginationInfo · object · required

Show child attributes