Skip to main content
POST
/
v2.0
/
playbooks
/
{playbookId}
/
steps
/
{stepId}
/
asserts
Create a new Playbook Step Assert
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/steps/{stepId}/asserts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "type": "assertText",
  "params": {}
}'
{
  "text": "hello world!",
  "data": {},
  "_id": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
playbookId
string
required

The Id of the Playbook

Required string length: 24
​
stepId
string
required

The Id of the Playbook Step

Required string length: 24

Body

application/json
​
type
enum<string>

The type of the Assert

Available options:
assertText,
assertData,
assertState,
assertContext,
assertIntent,
assertSlot
​
params
object

Response

Returns Playbook metadata object.

​
text
string

The text of the playbook step

Example:

"hello world!"

​
data
string

The data of this playbook step

Example:
{}
​
_id
string
Required string length: 24
⌘I