Skip to main content
PATCH
/
v2.0
/
flows
/
{flowId}
/
intents
/
{intentId}
/
sentences
/
{sentenceId}
Update an Example Sentence
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "text": "I want to buy a pizza.",
  "slots": [
    {
      "type": "anySlot",
      "name": "<string>",
      "start": 123,
      "end": 123
    }
  ]
}
'
{
  "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": {}
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

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

ā€‹
flowId
string
required

The unique identifier for the Flow.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
intentId
string
required

The unique identifier for the Intent.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
sentenceId
string
required

The unique identifier for the Example Sentence.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json

The payload for creating or updating an Example Sentence.

ā€‹
text
string

The text in the Example Sentence.

Example:

"I want to buy a pizza."

ā€‹
slots
object[]

The Slot segments in the Example Sentence. Each item defines a start and end indexes, and the Slot type: system-defined or user-defined Slot.

A Slot defined by the start and end indexes in the Example Sentence. The value is the text that appears in the range between the start and end indexes.

Response

Successfully updated Sentence