List Agents

List all agents.

GET /api/v1/agents

List Agents

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/agents \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/agents"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "object": "agent",
      "display_name": "<string>",
      "prompt_template_id": "<string>",
      "prompt_template_name": "<string>",
      "tools": [],
      "sources": [],
      "icon": "<string>",
      "custom_icon_id": "<string>",
      "is_background_agent": false,
      "can_be_used_as_tool": false,
      "ui_selectable": true,
      "order": 123
    }
  ],
  "has_more": true,
  "total": 123,
  "object": "list"
}

Authorizations

X-API-Key · string · header · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 50

name · string | null

status · string | null

Response

200 - application/json

OK

Paginated list response for agents.

data · AgentSummaryOut · object[] · required

Show child attributes

has_more · boolean · required

total · integer · required

object · string · default: list