Intents
Create an Intent
Creates an Intent in a Flow.
POST
/
v2.0
/
flows
/
{flowId}
/
intents
Create an Intent
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"parentIntentId": "<string>",
"analyticsLabel": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents"
payload = {
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": ["<string>"],
"isRejectIntent": True,
"isDisabled": True,
"tags": ["<string>"],
"confirmationSentences": ["<string>"],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": False,
"parentIntentId": "<string>",
"analyticsLabel": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'OrderFood',
description: 'Intent to order food',
condition: '<string>',
rules: ['<string>'],
isRejectIntent: true,
isDisabled: true,
tags: ['<string>'],
confirmationSentences: ['<string>'],
disambiguationSentence: '<string>',
data: {},
localeReference: '<string>',
childFeatures: false,
parentIntentId: '<string>',
analyticsLabel: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'OrderFood',
'description' => 'Intent to order food',
'condition' => '<string>',
'rules' => [
'<string>'
],
'isRejectIntent' => true,
'isDisabled' => true,
'tags' => [
'<string>'
],
'confirmationSentences' => [
'<string>'
],
'disambiguationSentence' => '<string>',
'data' => [
],
'localeReference' => '<string>',
'childFeatures' => false,
'parentIntentId' => '<string>',
'analyticsLabel' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents"
payload := strings.NewReader("{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"parentIntentId": "<string>",
"analyticsLabel": "<string>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Unauthorized",
"title": "Unauthorized Error",
"status": 401,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 401,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payment Required",
"title": "Payment Required Error",
"status": 402,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 402,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Forbidden",
"title": "Forbidden Error",
"status": 403,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Found",
"title": "Not Found Error",
"status": 404,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {},
"logLevel": "error"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}Authorizations
APIKeyHeaderAPIKeyQueryParamCXoneTokenHeaderOAuth2
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Available options:
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Flow.
Required string length:
24Pattern:
^[a-z0-9]{24}$Query Parameters
Required range:
5 <= x <= 20Body
application/json
Example:
"OrderFood"
Example:
"Intent to order food"
Required string length:
24Pattern:
^[a-z0-9]{24}$Example:
false
Available options:
parents, children Required string length:
24Pattern:
^[a-z0-9]{24}$Toggle overriding the flow setting for using default replies as training examples
Available options:
on, off, useFlowSettings Response
Returns Intent metadata object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
Example:
"OrderFood"
Example:
"Intent to order food"
Required string length:
24Pattern:
^[a-z0-9]{24}$Example:
false
Available options:
parents, children Required string length:
24Pattern:
^[a-z0-9]{24}$Toggle overriding the flow setting for using default replies as training examples
Available options:
on, off, useFlowSettings Required string length:
24Pattern:
^[a-z0-9]{24}$Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Required string length:
24Pattern:
^[a-z0-9]{24}$Required string length:
24Pattern:
^[a-z0-9]{24}$Last modified on July 22, 2026
Previous
Perform Batch Operations on IntentsPerforms batch operations on Intents in a Flow. Use this method to create, update, or delete multiple Intents in a request by specifying the operation type (`create`, `update`, or `delete`) for each item in the operations array.
Next
⌘I
Create an Intent
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"parentIntentId": "<string>",
"analyticsLabel": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents"
payload = {
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": ["<string>"],
"isRejectIntent": True,
"isDisabled": True,
"tags": ["<string>"],
"confirmationSentences": ["<string>"],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": False,
"parentIntentId": "<string>",
"analyticsLabel": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'OrderFood',
description: 'Intent to order food',
condition: '<string>',
rules: ['<string>'],
isRejectIntent: true,
isDisabled: true,
tags: ['<string>'],
confirmationSentences: ['<string>'],
disambiguationSentence: '<string>',
data: {},
localeReference: '<string>',
childFeatures: false,
parentIntentId: '<string>',
analyticsLabel: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'OrderFood',
'description' => 'Intent to order food',
'condition' => '<string>',
'rules' => [
'<string>'
],
'isRejectIntent' => true,
'isDisabled' => true,
'tags' => [
'<string>'
],
'confirmationSentences' => [
'<string>'
],
'disambiguationSentence' => '<string>',
'data' => [
],
'localeReference' => '<string>',
'childFeatures' => false,
'parentIntentId' => '<string>',
'analyticsLabel' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents"
payload := strings.NewReader("{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"OrderFood\",\n \"description\": \"Intent to order food\",\n \"condition\": \"<string>\",\n \"rules\": [\n \"<string>\"\n ],\n \"isRejectIntent\": true,\n \"isDisabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"confirmationSentences\": [\n \"<string>\"\n ],\n \"disambiguationSentence\": \"<string>\",\n \"data\": {},\n \"localeReference\": \"<string>\",\n \"childFeatures\": false,\n \"parentIntentId\": \"<string>\",\n \"analyticsLabel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"parentIntentId": "<string>",
"analyticsLabel": "<string>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Unauthorized",
"title": "Unauthorized Error",
"status": 401,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 401,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payment Required",
"title": "Payment Required Error",
"status": 402,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 402,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Forbidden",
"title": "Forbidden Error",
"status": 403,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Found",
"title": "Not Found Error",
"status": 404,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {},
"logLevel": "error"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}