Playbook Test Document Uploads

Gets all test document uploads for the specified playbook.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

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

text/plainapplication/jsontext/json

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuidRequired

contentTypestring · nullableOptional

sizeinteger · int64 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

uploadSuccessfulboolean · nullableOptional

tokenCountinteger · int64 · nullableOptional

metadataTokenCountinteger · int64 · nullableOptional

unsupportedFileTypeboolean · nullableOptional

unPackingCompleteboolean · nullableOptional

unPackingFailedboolean · nullableOptional

uploadInProgressboolean · nullableOptional

urlstring · nullableOptional

hasChildrenboolean · nullableOptional

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/test-document-uploads

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/test-document-uploads 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": "2026-03-13T11:30:40.956Z",
    "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 upload to the specified playbook.

post

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

isCompletedbooleanRequired

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}/test-document-uploads

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "isCompleted": true
}

application/jsontext/jsonapplication/*+json

{
  "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": "2026-03-13T11:30:40.956Z",
  "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 upload by its object identifier.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the test document upload.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuidRequired

contentTypestring · nullableOptional

sizeinteger · int64 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

uploadSuccessfulboolean · nullableOptional

tokenCountinteger · int64 · nullableOptional

metadataTokenCountinteger · int64 · nullableOptional

unsupportedFileTypeboolean · nullableOptional

unPackingCompleteboolean · nullableOptional

unPackingFailedboolean · nullableOptional

uploadInProgressboolean · nullableOptional

urlstring · nullableOptional

hasChildrenboolean · nullableOptional

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/test-document-uploads/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/test-document-uploads/{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": "2026-03-13T11:30:40.956Z",
  "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 upload for the specified playbook.

patch

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the test document upload to update.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

isCompletedbooleanRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuidRequired

contentTypestring · nullableOptional

sizeinteger · int64 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

uploadSuccessfulboolean · nullableOptional

tokenCountinteger · int64 · nullableOptional

metadataTokenCountinteger · int64 · nullableOptional

unsupportedFileTypeboolean · nullableOptional

unPackingCompleteboolean · nullableOptional

unPackingFailedboolean · nullableOptional

uploadInProgressboolean · nullableOptional

urlstring · nullableOptional

hasChildrenboolean · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

patch

/playbooks/{playbookIdentifier}/test-document-uploads/{objectIdentifier}

HTTPcURLJavaScriptPython

PATCH /playbooks/{playbookIdentifier}/test-document-uploads/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "isCompleted": true
}

application/jsontext/jsonapplication/*+json

{
  "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": "2026-03-13T11:30:40.956Z",
  "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"
  }
}