Skip to main content
GET
/
v1
/
agents
Get Agents
curl --request GET \
  --url https://api.example.com/v1/agents \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "definition": {},
      "description": "<string>",
      "visible": true,
      "image_url": "<string>",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "app_settings_v2": {
        "is_active": false,
        "version_id": "<string>",
        "interface_type": "slack",
        "extra_settings": {},
        "published_at": "2023-11-07T05:31:56Z"
      },
      "is_app_published": true,
      "allow_public_access": false,
      "meta": {
        "template_id": "<string>"
      }
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

X-API-Key
string
header
required

Query Parameters

query
string | null
status
string | null
order_by
string
default:last_updated_at
sort
string
default:desc
page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

items
Assistant · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1
pages
integer
required
Required range: x >= 0