Playbook

Gets the details of the specified playbook.

get

Retrieves the details of the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2025-12-06T04:07:51.931Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2025-12-06T04:07:51.931Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Updates the specified playbook.

put

Updates the details of the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to update.

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

descriptionstring | nullableRequired

isPrivatebooleanRequired

organizationWidebooleanRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/playbooks/{playbookIdentifier}

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2025-12-06T04:07:51.931Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2025-12-06T04:07:51.931Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2025-12-06T04:07:51.931Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Deletes the specified playbook.

delete

Deletes the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Exports the specified playbook as a ZIP file.

get

Exports the specified playbook as a ZIP file.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to export.

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · binary

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/export

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Clones the specified playbook.

post

Clones the specified playbook with a new name and description.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to clone.

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

descriptionstring | nullableRequired

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/clone

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/clone HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2025-12-06T04:07:51.931Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2025-12-06T04:07:51.931Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Gets the image for the specified playbook.

get

Retrieves the image file for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook.

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · binary

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/image

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/image HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Adds an image to the specified playbook.

post

Uploads an image file to the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook.

Body

multipart/form-data

imagestring · binaryOptional

The image file to upload.

Responses

201

Created

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/image

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/image HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

No content