v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Intents

Update intent

Manages a single intent. Requires a USER API key.

put/public/v1/agents/{agentId}/intents/{intentId}

Path parameters

agentIdstring required

Example:uuid-xxxx-xxxx

intentIdnumber nullable

Example:10

Request body

namestring required

descriptionstring nullable

Example request

{
  "name": "Cancel order",
  "description": "User wants to cancel",
  "phrases": [
    {
      "id": 1,
      "phrase": "cancel my order"
    }
  ]
}

Response

Intent

idnumber required

namestring required

descriptionstring nullable

createdAtstring nullable required

updatedAtstring nullable required

status'ACTIVE' | 'DELETED' required

assistantIdstring required

flowIdnumber nullable

Example response

{
  "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
}