Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Flows
- POSTCreate a Flow
- PATCHPerform Batch Operations on Flows
- GETGet a Flow
- DELDelete a Flow
- PATCHUpdate a Flow
- POSTAdd a Locale to a Flow
- GETGet the Chart of specified Flow
- POSTCreate a Flow from a Child Node
- POSTClone a Flow
- POSTRemove a Locale from a Flow
- GETGet Flow Settings
- PATCHUpdate Flow Settings
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create a Flow
Creates a Flow in a Project.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"context": {},
"attachedFlows": [
"<string>"
],
"attachedLexicons": [
"<string>"
],
"img": "<string>",
"projectId": "<string>"
}
'{
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentTrainGroupReference": "<string>",
"feedbackReport": {
"findings": [
{
"type": "poorAccuracy"
}
],
"info": {
"fScore": 123
}
},
"isTrainingOutOfDate": true,
"name": "<string>",
"description": "<string>",
"context": {},
"attachedFlows": [
"<string>"
],
"attachedLexicons": [
"<string>"
],
"img": "<string>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Query Parameters
An Id of a resource within the corresponding project to copy from
24^[a-z0-9]{24}$Body
24^[a-z0-9]{24}$24^[a-z0-9]{24}$The unique identifier for the Project.
24^[a-z0-9]{24}$Response
Returns Flow 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.
24^[a-z0-9]{24}$Show child attributes
Show child attributes
24^[a-z0-9]{24}$24^[a-z0-9]{24}$24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"context": {},
"attachedFlows": [
"<string>"
],
"attachedLexicons": [
"<string>"
],
"img": "<string>",
"projectId": "<string>"
}
'{
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentTrainGroupReference": "<string>",
"feedbackReport": {
"findings": [
{
"type": "poorAccuracy"
}
],
"info": {
"fScore": 123
}
},
"isTrainingOutOfDate": true,
"name": "<string>",
"description": "<string>",
"context": {},
"attachedFlows": [
"<string>"
],
"attachedLexicons": [
"<string>"
],
"img": "<string>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}