Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Example Sentences

Create an Example Sentence

Creates an Example Sentence for an Intent.

post/v2.0/flows/{flowId}/intents/{intentId}/sentences

Path parameters

flowIdstring required

The unique identifier for the Flow.

intentIdstring required

The unique identifier for the Intent.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

textstring

The text in the Example Sentence.

Example request

{
  "text": "I want to buy a pizza."
}

Response

Returns Sentence metadata object.

localeReferencestring
textstring

The text in the Example Sentence.

_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "text": "I want to buy a pizza.",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}