Skip to main content
GET
/
api
/
v1
/
agents
List Agents
curl --request GET \
  --url https://api.example.com/api/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "name": "<string>",
      "autoConfirm": true,
      "emailTrigger": {
        "email": "<string>",
        "active": true,
        "allowedSenders": [
          "<string>"
        ]
      },
      "dataDestinations": [
        {
          "runnerTags": [
            "<string>"
          ],
          "workflows": [
            "<string>"
          ],
          "type": "ASKUI_WORKFLOW"
        }
      ],
      "workspaceId": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "description": "",
      "dataSchema": {
        "properties": {},
        "title": "DataToExtract",
        "description": "",
        "type": "object",
        "required": [
          "<string>"
        ]
      },
      "folderPath": "<string>"
    }
  ],
  "hasMore": false,
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
agent_id
string<uuid4>[] | null
​
workspace_id
string<uuid4>[] | null
​
status
enum<string>[] | null
Available options:
ACTIVE,
ARCHIVED
​
skip
integer
default:0
Required range: x >= 0
​
limit
integer
default:100
Required range: 1 <= x <= 100
​
expand
string[] | null

total_count: Include the total number of agents that match the query, only accurate up to 100.

Allowed value: "total_count"

Response

Successful Response

​
data
Agent · object[]
required
​
hasMore
boolean
default:false

Whether there are more agents that match the query that were not included in this response.

​
totalCount
integer | null

The total number of agents that match the query, only accurate up to 100.