Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Playbooks

Create a Playbook

Creates a Playbook in a Project.

post/v2.0/playbooks

Query parameters

resourceIdstring

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

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

namestring required

The name of the Playbook.

projectIdstring required

The unique identifier for the Project.

abortOnErrorboolean

If set to true, Playbook execution stops when an assertion error occurs. The default value is false.

timeoutinteger

The timeout in milliseconds after which a Playbook Step is treated as failed. The default is 2000.

Example request

{
  "name": "New Playbook",
  "projectId": "66e06026706e6e0016a30e12",
  "timeout": 3000
}

Response

Playbook object successfully created.

namestring

The name of the Playbook

abortOnErrorboolean

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

timeoutinteger

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

_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "name": "New Playbook",
  "timeout": 2000,
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "steps": [
    {
      "text": "hello world!"
    }
  ]
}