For the complete documentation index, see llms.txt. This page is also available as Markdown.

Playbook Reference Material Categories

Get all categories for a reference material.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
dateAddedstring · date-timeOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/categories
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "dateAdded": "2026-01-01T00:00:00.000Z"
  }
]

Add a category to a reference material.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Body
namestring · nullableRequired
Responses
201

Created

objectIdentifierstring · uuidRequired
namestring · nullableRequired
dateAddedstring · date-timeOptional
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/categories
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z"
}

Delete a category from a reference material.

delete
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Responses
204

No Content

No content

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

No content

Last updated