Get all DXAs

Get Agents

The Get Agents endpoint retrieves a list of all Domain Expert Agents (DXAs) associated with the current user. This allows you to manage and interact with your agents programmatically.

Endpoint

GET /agents

## Parameters

| Name     | Type   | In    | Description                                |
|----------|--------|-------|--------------------------------------------|
| limit    | int    | query | Number of agents to return (default: 10)   |
| offset   | int    | query | Number of agents to skip (default: 0)      |

cURL Example

curl -X GET 'https://{api_endpoints}/agents?limit=10&offset=0' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Success Response

{
  "status": "ok",
  "agents": [
    {
      "id": "string",
      "agent_id": "string",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "name": "string",
      "description": "string",
      "general_agent_config": {},
      "is_published": true,
      "status": "string",
      "suggested_questions": ["string"],
      "user_id": "string",
      "user": {
        "id": 0,
        "name": "string",
        "email": "string",
        "picture": "string",
        "username": "string",
        "data": {},
        "user_type": "string"
      },
      "agent_type": "string"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 100
  }
}

Last updated