Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Intents

List intents

Lists agent intents. Requires a USER API key.

get/public/v1/agents/{agentId}/intents

Path parameters

agentIdstring required
Example:uuid-xxxx-xxxx

Query parameters

filterTextstring
Example:cancel
boolean
OR
string
Example:example

Response

Paginated intents

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber
cursornumber
paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": 10,
      "name": "Cancel order",
      "description": "example",
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z",
      "status": "ACTIVE",
      "assistantId": "550e8400-e29b-41d4-a716-446655440000",
      "phrases": [
        {
          "id": 1,
          "phrase": "cancel my order"
        }
      ],
      "flowId": 1
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}