v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
agents

List V2 chat agents

Returns cursor-paginated V2 chat agents for a workspace, including their attached skills and triggers.

get/v1/agents

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o
limitinteger
cursorstring

Response

V2 chat agents

next_cursorstring nullable required
has_moreboolean required

Example response

{
  "data": [
    {
      "id": "ag77c0dy0mgdpzmqz6tesry8w184002s",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "Reservations",
      "description": "Handles booking and cancellation flows.",
      "color": "#2563EB",
      "icon_id": 12,
      "version": "v2",
      "instructions": "Answer booking questions, use policies before escalating, and keep replies concise.",
      "model": "default",
      "guardrails": [
        {
          "id": "guardrail_1",
          "title": "Do not promise refunds",
          "knowledge": "Only cite refund terms from approved policy docs or escalate."
        }
      ],
      "operation_mode": "autopilot",
      "autopilot_schedule": null,
      "custom_response_delay_ms": 10000,
      "auto_mark_as_done": false,
      "response_language": "English",
      "responseflow": true,
      "output_schema": [
        {
          "name": "resolution",
          "description": "Short summary of the final outcome.",
          "type": "string",
          "is_required": true
        }
      ],
      "skill_ids": [
        "ks77c0dy0mgdpzmqz6tesry8w184002s"
      ],
      "connection_ids": [
        "cn77c0dy0mgdpzmqz6tesry8w184002s"
      ],
      "enabled": true,
      "triggers": [
        {
          "id": "tr77c0dy0mgdpzmqz6tesry8w184002s",
          "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
          "name": "All Messages",
          "description": "Runs for every inbound message.",
          "type": "message",
          "config": {
            "scopeType": "all"
          },
          "enabled": true,
          "created_at": "2026-04-01T17:22:10.000Z",
          "updated_at": "2026-04-03T03:14:15.000Z"
        },
        {
          "id": "tr88c0dy0mgdpzmqz6tesry8w184003s",
          "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
          "name": "Contact Inbox",
          "description": "Runs only for contact-type inbox messages.",
          "type": "message",
          "config": {
            "scopeType": "inbox",
            "inboxTypeId": "guest"
          },
          "enabled": true,
          "created_at": "2026-04-01T17:22:10.000Z",
          "updated_at": "2026-04-03T03:14:15.000Z"
        },
        {
          "id": "tr99c0dy0mgdpzmqz6tesry8w184004s",
          "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
          "name": "SMS Channel",
          "description": "Runs only for SMS channel messages.",
          "type": "message",
          "config": {
            "scopeType": "channel",
            "channelType": "sms"
          },
          "enabled": true,
          "created_at": "2026-04-01T17:22:10.000Z",
          "updated_at": "2026-04-03T03:14:15.000Z"
        }
      ],
      "created_at": "2026-04-01T17:22:10.000Z",
      "updated_at": "2026-04-03T03:14:15.000Z"
    }
  ],
  "next_cursor": "page-token",
  "has_more": true
}
All 87 operations