Playbook Reference Materials

Get all reference materials for a playbook.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

namestring · nullableRequired

descriptionstring · nullableOptional

typestring · enumOptionalPossible values:

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

dateAddedstring · date-timeOptional

403

Forbidden

get/playbooks/{playbookIdentifier}/reference-materials

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

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "type": "boolean",
    "booleanValue": true,
    "isSourceDocuments": true,
    "dateTimeValue": "2026-01-01T00:00:00.000Z",
    "decimalValue": 1,
    "textValue": "text",
    "isLocked": true,
    "isRequired": true,
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "categories": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "dateAdded": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
]

Create a new reference material for a playbook.

post

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

namestring · nullableRequired

descriptionstring · nullableOptional

typestring · enumRequiredPossible values:

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

Responses

201

Created

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

namestring · nullableRequired

descriptionstring · nullableOptional

typestring · enumOptionalPossible values:

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

dateAddedstring · date-timeOptional

400

Bad Request

403

Forbidden

post/playbooks/{playbookIdentifier}/reference-materials

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

{
  "name": "text",
  "description": "text",
  "type": "boolean",
  "booleanValue": true,
  "isSourceDocuments": true,
  "dateTimeValue": "2026-01-01T00:00:00.000Z",
  "decimalValue": 1,
  "textValue": "text",
  "isLocked": true,
  "isRequired": true,
  "categories": [
    {
      "name": "text"
    }
  ]
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "boolean",
  "booleanValue": true,
  "isSourceDocuments": true,
  "dateTimeValue": "2026-01-01T00:00:00.000Z",
  "decimalValue": 1,
  "textValue": "text",
  "isLocked": true,
  "isRequired": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get a specific reference material by object identifier.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

namestring · nullableRequired

descriptionstring · nullableOptional

typestring · enumOptionalPossible values:

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

dateAddedstring · date-timeOptional

403

Forbidden

404

Not Found

get/playbooks/{playbookIdentifier}/reference-materials/{objectIdentifier}

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

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "boolean",
  "booleanValue": true,
  "isSourceDocuments": true,
  "dateTimeValue": "2026-01-01T00:00:00.000Z",
  "decimalValue": 1,
  "textValue": "text",
  "isLocked": true,
  "isRequired": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Update an existing reference material for a playbook.

put

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Body

namestring · nullableRequired

descriptionstring · nullableOptional

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

namestring · nullableRequired

descriptionstring · nullableOptional

typestring · enumOptionalPossible values:

booleanValueboolean · nullableOptional

isSourceDocumentsboolean · nullableOptional

dateTimeValuestring · date-time · nullableOptional

decimalValuenumber · double · nullableOptional

textValuestring · nullableOptional

isLockedbooleanOptional

isRequiredbooleanOptional

dateAddedstring · date-timeOptional

400

Bad Request

403

Forbidden

404

Not Found

put/playbooks/{playbookIdentifier}/reference-materials/{objectIdentifier}

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

{
  "name": "text",
  "description": "text",
  "booleanValue": true,
  "isSourceDocuments": true,
  "dateTimeValue": "2026-01-01T00:00:00.000Z",
  "decimalValue": 1,
  "textValue": "text",
  "isLocked": true,
  "isRequired": true
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "boolean",
  "booleanValue": true,
  "isSourceDocuments": true,
  "dateTimeValue": "2026-01-01T00:00:00.000Z",
  "decimalValue": 1,
  "textValue": "text",
  "isLocked": true,
  "isRequired": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Delete a reference material from a playbook.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

404

Not Found

409

Conflict

delete/playbooks/{playbookIdentifier}/reference-materials/{objectIdentifier}

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

No content