INTENT

All Intents

get

https://api.example.comhttps://staging-api.example.com

/api/v1/intent

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/intent

HTTPcURLJavaScriptPython

GET /api/v1/intent HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Create Intent

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"greeting","scopeId":1,"description":"Greeting intent","context":"greetings","type":"general","language":"en","expressions":["hello","hi there","good morning","how are you"],"responses":["Hello! How can I help you today?","Hi there! What can I do for you?"]}

Responses

200

Successful response

application/json

post

/api/v1/intent/

HTTPcURLJavaScriptPython

POST /api/v1/intent/ HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "name": "greeting",
  "scopeId": 1,
  "description": "Greeting intent",
  "context": "greetings",
  "type": "general",
  "language": "en",
  "expressions": [
    "hello",
    "hi there",
    "good morning",
    "how are you"
  ],
  "responses": [
    "Hello! How can I help you today?",
    "Hi there! What can I do for you?"
  ]
}

200

Successful response

Single Intent

get

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 2

Responses

200

Successful response

application/json

get

/api/v1/intent/{intentId}

HTTPcURLJavaScriptPython

GET /api/v1/intent/{intentId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Edit Intent

put

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 29

Body

application/json

objectOptionalExample: {"name":"Updated Intent","scopeId":1,"type":"test","description":"Updated description","context":"Updated context","expressions":["updated expression one","updated expression two"],"responses":["updated response one","updated response two"]}

Responses

200

Successful response

application/json

put

/api/v1/intent/{intentId}

HTTPcURLJavaScriptPython

PUT /api/v1/intent/{intentId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "name": "Updated Intent",
  "scopeId": 1,
  "type": "test",
  "description": "Updated description",
  "context": "Updated context",
  "expressions": [
    "updated expression one",
    "updated expression two"
  ],
  "responses": [
    "updated response one",
    "updated response two"
  ]
}

200

Successful response

Delete Intent

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

delete

/api/v1/intent/{intentId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/intent/{intentId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

get languages

get

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/find/languages

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/intent/find/languages

HTTPcURLJavaScriptPython

GET /api/v1/intent/find/languages HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Toggle Intent Permission

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"permissionSlug":"example-permission-slug","name":"Example Permission"}

Responses

200

Successful response

application/json

post

/api/v1/intent/{intentId}/permission

HTTPcURLJavaScriptPython

POST /api/v1/intent/{intentId}/permission HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "permissionSlug": "example-permission-slug",
  "name": "Example Permission"
}

200

Successful response

Set Permissions

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/permission/set

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"slugArray":["permission-slug-1","permission-slug-2"]}

Responses

200

Successful response

application/json

post

/api/v1/intent/{intentId}/permission/set

HTTPcURLJavaScriptPython

POST /api/v1/intent/{intentId}/permission/set HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "slugArray": [
    "permission-slug-1",
    "permission-slug-2"
  ]
}

200

Successful response

Create New Expression

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/expression

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"expression":"new expression text"}

Responses

200

Successful response

application/json

post

/api/v1/intent/{intentId}/expression

HTTPcURLJavaScriptPython

POST /api/v1/intent/{intentId}/expression HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "expression": "new expression text"
}

200

Successful response

Delete One Expression

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/expression

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Responses

200

Successful response

application/json

delete

/api/v1/intent/{intentId}/expression

HTTPcURLJavaScriptPython

DELETE /api/v1/intent/{intentId}/expression HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Modify One Expression

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/expression

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"oldExpression":"old expression text","newExpression":"modified expression text"}

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/expression

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/expression HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "oldExpression": "old expression text",
  "newExpression": "modified expression text"
}

200

Successful response

Create New Response

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/response

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 31

Body

application/json

objectOptionalExample: {"response":"new response text","is_rounded":true}

Responses

200

Successful response

application/json

post

/api/v1/intent/{intentId}/response

HTTPcURLJavaScriptPython

POST /api/v1/intent/{intentId}/response HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "response": "new response text",
  "is_rounded": true
}

200

Successful response

Delete One Response

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/response

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Responses

200

Successful response

application/json

delete

/api/v1/intent/{intentId}/response

HTTPcURLJavaScriptPython

DELETE /api/v1/intent/{intentId}/response HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Modify One Response

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/response

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"oldResponse":"old response text","newResponse":"modified response text"}

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/response

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/response HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "oldResponse": "old response text",
  "newResponse": "modified response text"
}

200

Successful response

Modify Context

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/context

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptionalExample: {"context":"updated context text"}

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/context

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/context HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "context": "updated context text"
}

200

Successful response

Toggle Debug Mode

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/debug

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 6

Body

application/json

objectOptional

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/debug

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/debug HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

Delete Expression By ID

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/expression/{expressionId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 30

expressionIdintegerRequiredExample: 105

Responses

200

Successful response

application/json

delete

/api/v1/intent/{intentId}/expression/{expressionId}

HTTPcURLJavaScriptPython

DELETE /api/v1/intent/{intentId}/expression/{expressionId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Update Expression By ID

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/expression/{expressionId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 30

expressionIdintegerRequiredExample: 106

Body

application/json

objectOptionalExample: {"newExpression":"updated expression text"}

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/expression/{expressionId}

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/expression/{expressionId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "newExpression": "updated expression text"
}

200

Successful response

Delete Response By ID

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/response/{responseId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 31

responseIdintegerRequiredExample: 185

Responses

200

Successful response

application/json

delete

/api/v1/intent/{intentId}/response/{responseId}

HTTPcURLJavaScriptPython

DELETE /api/v1/intent/{intentId}/response/{responseId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Update Response By ID

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/{intentId}/response/{responseId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

intentIdintegerRequiredExample: 31

responseIdintegerRequiredExample: 185

Body

application/json

objectOptionalExample: {"newResponse":"updated response text"}

Responses

200

Successful response

application/json

patch

/api/v1/intent/{intentId}/response/{responseId}

HTTPcURLJavaScriptPython

PATCH /api/v1/intent/{intentId}/response/{responseId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "newResponse": "updated response text"
}

200

Successful response

Create Bulk Intents

post

https://api.example.comhttps://staging-api.example.com

/api/v1/intent/bulk

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

Responses

200

Successful response

application/json

post

/api/v1/intent/bulk

HTTPcURLJavaScriptPython

POST /api/v1/intent/bulk HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response