Playbook Test Documents

Gets all test documents for the specified playbook.

get

Retrieves a paginated list of all test documents for the specified playbook, with optional search and sorting.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional

The page number for paginated results.

parentObjectIdentifierstring · uuidOptional

Optional parent folder object identifier.

flattenListbooleanOptional

Whether to flatten the folder structure.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:
descbooleanOptional

Whether to sort in descending order.

Default: true
Responses
200

OK

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

[
  {
    "name": "text",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isDirectory": true,
    "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "contentType": "text",
    "size": 1,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2025-12-06T04:07:51.949Z",
    "uploadSuccessful": true,
    "tokenCount": 1,
    "metadataTokenCount": 1,
    "unsupportedFileType": true,
    "unPackingComplete": true,
    "unPackingFailed": true,
    "uploadInProgress": true,
    "url": "text",
    "hasChildren": true,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  }
]

Uploads a new test document to the specified playbook.

post

Creates and uploads a new test document for the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Query parameters
parentObjectIdentifierstring · uuidOptional

Optional parent folder object identifier.

documentUploadIdentifierstring · uuidRequired

The identifier for the document upload session.

Body
filestring · binaryOptional

The file to upload.

Responses
post
/playbooks/{playbookIdentifier}/test-documents
POST /playbooks/{playbookIdentifier}/test-documents?documentUploadIdentifier=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Creates an empty test document in the specified playbook.

post

Creates an empty test document for the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Query parameters
parentObjectIdentifierstring · uuidOptional

Optional parent folder object identifier.

fileNamestringRequired

The name of the file to create.

contentTypestringRequired

The content type of the file.

documentUploadIdentifierstring · uuidRequired

The identifier for the document upload session.

Responses
post
/playbooks/{playbookIdentifier}/test-documents/empty
POST /playbooks/{playbookIdentifier}/test-documents/empty?fileName=text&contentType=text&documentUploadIdentifier=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Appends a chunk to a partially uploaded test document.

post

Appends a file chunk to a test document being uploaded in parts.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the document being uploaded.

playbookIdentifierstringRequired
Query parameters
chunkIndexinteger · int32Optional

The index of the chunk.

lastChunkbooleanOptional

Indicates if this is the last chunk.

Default: false
Body
filestring · binaryOptional

The file chunk to append.

Responses
200

OK

post
/playbooks/{playbookIdentifier}/test-documents/{objectIdentifier}/append-chunk
POST /playbooks/{playbookIdentifier}/test-documents/{objectIdentifier}/append-chunk HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Gets a specific test document by its object identifier.

get

Retrieves the details of a test document for the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the test document.

playbookIdentifierstringRequired
Responses
200

OK

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

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Updates an existing test document in the specified playbook.

put

Updates the details of an existing test document for the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the document to update.

playbookIdentifierstringRequired
Body
namestring | nullableRequired
parentObjectIdentifierstring · uuid | nullableOptional
isDirectorybooleanOptional
documentUploadObjectIdentifierstring · uuidRequired
Responses
200

OK

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

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Deletes a test document from the specified playbook.

delete

Deletes a test document from the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the document to delete.

playbookIdentifierstringRequired
Responses
delete
/playbooks/{playbookIdentifier}/test-documents/{objectIdentifier}
DELETE /playbooks/{playbookIdentifier}/test-documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Adds a new folder to the test documents of the specified playbook.

post

Creates a new folder within the test documents of the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Body
namestring | nullableRequired
parentObjectIdentifierstring · uuid | nullableOptional
Responses
post
/playbooks/{playbookIdentifier}/test-documents/folder
POST /playbooks/{playbookIdentifier}/test-documents/folder HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Downloads a test document file from the specified playbook.

get

Downloads the file for a test document in the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the document to download.

playbookIdentifierstringRequired
Responses
200

OK

Responsestring · binary
get
/playbooks/{playbookIdentifier}/test-documents/{objectIdentifier}/download
GET /playbooks/{playbookIdentifier}/test-documents/{objectIdentifier}/download HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Updates an existing folder in the test documents of the specified playbook.

put

Updates the details of an existing folder within the test documents of the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the folder to update.

playbookIdentifierstringRequired
Body
namestring | nullableRequired
parentObjectIdentifierstring · uuid | nullableOptional
Responses
200

OK

put
/playbooks/{playbookIdentifier}/test-documents/folder/{objectIdentifier}
PUT /playbooks/{playbookIdentifier}/test-documents/folder/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.949Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}
PreviousPlaybook Test Document UploadsNextPlaybooks

Last updated