Create Intent

Create a new intent

POST /api/v1/intent

Create Intent

cURL

curl --request POST \
  --url 'https://api.example.com/api/v1/intent?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "attributes": {},
  "is_active": true,
  "intent_type": "user"
}
'

201

{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "intent_type": "<string>",
    "name": "<string>",
    "description": "<string>",
    "attributes": {},
    "is_active": true
  }
}

Authorizations

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json

name · string | null

description · string | null

attributes · Attributes · object

is_active · boolean | null · default: true

intent_type · string | null · default: user

Response

201

application/json

Successful Response

message · string | null · default: Data created successfully

meta · Meta · object

data · IIntentRead · object

Show child attributes