INTENT

All Intents

get
/api/v1/intent
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/api/v1/intent
200

Successful response

No content

Create Intent

post
/api/v1/intent/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
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
post
/api/v1/intent/
200

Successful response

No content

Single Intent

get
/api/v1/intent/{intentId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 2
Responses
get
/api/v1/intent/{intentId}
200

Successful response

No content

Edit Intent

put
/api/v1/intent/{intentId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 29
Body
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
put
/api/v1/intent/{intentId}
200

Successful response

No content

Delete Intent

delete
/api/v1/intent/{intentId}/delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 1
Responses
delete
/api/v1/intent/{intentId}/delete
200

Successful response

No content

get languages

get
/api/v1/intent/find/languages
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/api/v1/intent/find/languages
200

Successful response

No content

Toggle Intent Permission

post
/api/v1/intent/{intentId}/permission
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"permissionSlug":"example-permission-slug","name":"Example Permission"}
Responses
post
/api/v1/intent/{intentId}/permission
200

Successful response

No content

Set Permissions

post
/api/v1/intent/{intentId}/permission/set
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"slugArray":["permission-slug-1","permission-slug-2"]}
Responses
post
/api/v1/intent/{intentId}/permission/set
200

Successful response

No content

Create New Expression

post
/api/v1/intent/{intentId}/expression
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"expression":"new expression text"}
Responses
post
/api/v1/intent/{intentId}/expression
200

Successful response

No content

Delete One Expression

delete
/api/v1/intent/{intentId}/expression
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Responses
delete
/api/v1/intent/{intentId}/expression
200

Successful response

No content

Modify One Expression

patch
/api/v1/intent/{intentId}/expression
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"oldExpression":"old expression text","newExpression":"modified expression text"}
Responses
patch
/api/v1/intent/{intentId}/expression
200

Successful response

No content

Create New Response

post
/api/v1/intent/{intentId}/response
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 31
Body
objectOptionalExample: {"response":"new response text","is_rounded":true}
Responses
post
/api/v1/intent/{intentId}/response
200

Successful response

No content

Delete One Response

delete
/api/v1/intent/{intentId}/response
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Responses
delete
/api/v1/intent/{intentId}/response
200

Successful response

No content

Modify One Response

patch
/api/v1/intent/{intentId}/response
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"oldResponse":"old response text","newResponse":"modified response text"}
Responses
patch
/api/v1/intent/{intentId}/response
200

Successful response

No content

Modify Context

patch
/api/v1/intent/{intentId}/context
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptionalExample: {"context":"updated context text"}
Responses
patch
/api/v1/intent/{intentId}/context
200

Successful response

No content

Toggle Debug Mode

patch
/api/v1/intent/{intentId}/debug
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 6
Body
objectOptional
Responses
patch
/api/v1/intent/{intentId}/debug
200

Successful response

No content

Delete Expression By ID

delete
/api/v1/intent/{intentId}/expression/{expressionId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 30
expressionIdintegerRequiredExample: 105
Responses
delete
/api/v1/intent/{intentId}/expression/{expressionId}
200

Successful response

No content

Update Expression By ID

patch
/api/v1/intent/{intentId}/expression/{expressionId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 30
expressionIdintegerRequiredExample: 106
Body
objectOptionalExample: {"newExpression":"updated expression text"}
Responses
patch
/api/v1/intent/{intentId}/expression/{expressionId}
200

Successful response

No content

Delete Response By ID

delete
/api/v1/intent/{intentId}/response/{responseId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 31
responseIdintegerRequiredExample: 185
Responses
delete
/api/v1/intent/{intentId}/response/{responseId}
200

Successful response

No content

Update Response By ID

patch
/api/v1/intent/{intentId}/response/{responseId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
intentIdintegerRequiredExample: 31
responseIdintegerRequiredExample: 185
Body
objectOptionalExample: {"newResponse":"updated response text"}
Responses
patch
/api/v1/intent/{intentId}/response/{responseId}
200

Successful response

No content

Create Bulk Intents

post
/api/v1/intent/bulk
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
objectOptional
Responses
post
/api/v1/intent/bulk
200

Successful response

No content

Last updated