Skip to main content
POST
/
v2.0
/
playbooks
Create a new Playbook
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "New Playbook",
  "projectId": "66e06026706e6e0016a30e12",
  "abortOnError": false,
  "timeout": 2000
}'
{
  "name": "New Playbook",
  "abortOnError": true,
  "timeout": 2000,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "steps": [
    {
      "text": "hello world!",
      "data": {},
      "_id": "<string>",
      "asserts": [
        {
          "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

Query Parameters

​
resourceId
string

An Id of a resource within the corresponding project to copy from

Required string length: 24

Body

application/json
​
name
string
required

The name of the Playbook

Example:

"New Playbook"

​
projectId
string
required

The id of the project

Example:

"66e06026706e6e0016a30e12"

​
abortOnError
boolean
required

Flag whether to stop Playbook execution when an assert-error occurred

Example:

false

​
timeout
integer
required

A time (in ms) after which a playbook step is 'invalid/failed'

Required range: x >= 1
Example:

2000

Response

Returns Playbook 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.

​
name
string

The name of the Playbook

Example:

"New Playbook"

​
abortOnError
boolean

Flag wheter to stop Playbook execution when an assert-error occured

​
timeout
integer

A time (in ms) after which a playbook step is 'invalid/failed'

Required range: x >= 1
Example:

2000

​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24
​
steps
object[]