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

Playbook Source Documents

List documents under a reference material.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Query parameters
parentObjectIdentifierstring · uuidOptional
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
searchTextstringOptional
flattenbooleanOptionalDefault: false
hidePackagedFilesbooleanOptionalDefault: true
indexingStatusstring · enumOptionalPossible values:
documentUploadObjectIdentifierstring · uuidOptional
sortingstring · enumOptionalPossible values:
descbooleanOptionalDefault: true
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "extension": "text",
    "contentType": "text",
    "size": 1,
    "isDirectory": true,
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "uploadSuccessful": true,
    "uploadInProgress": true,
    "uploadFailedReason": "outOfMemory",
    "fileType": "unknown",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "hasChildren": true,
    "pageCount": 1,
    "tokenCount": 1,
    "documentUploadSource": "local",
    "isPackagedFile": true,
    "unpackedFileCount": 1
  }
]

Upload a document to a reference material.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Query parameters
documentUploadObjectIdentifierstring · uuidOptional
parentObjectIdentifierstring · uuidOptional
Body
filestring · binaryOptional
ocrEnginestring · enumOptionalPossible values:
ocrStrategystring · enumOptionalPossible values:
coordinateExtractionStrategystring · enumOptionalPossible values:
Responses
201

Created

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 118

{
  "file": "binary",
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never"
}
{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "extension": "text",
  "contentType": "text",
  "size": 1,
  "isDirectory": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "uploadSuccessful": true,
  "uploadInProgress": true,
  "uploadFailedReason": "outOfMemory",
  "fileType": "unknown",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildren": true,
  "pageCount": 1,
  "tokenCount": 1,
  "documentUploadSource": "local",
  "isPackagedFile": true,
  "unpackedFileCount": 1
}

Initialise a document record before uploading content.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Body
fileNamestring · nullableRequired
contentTypestring · nullableRequired
parentObjectIdentifierstring · uuid · nullableOptional
documentUploadObjectIdentifierstring · uuidRequired
Responses
201

Created

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/initialise
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/initialise HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "fileName": "text",
  "contentType": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "uploadSettings": {
    "ocrEngine": "azureDocumentIntelligence",
    "ocrStrategy": "never",
    "coordinateExtractionStrategy": "never"
  }
}
201

Created

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "extension": "text",
  "contentType": "text",
  "size": 1,
  "isDirectory": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "uploadSuccessful": true,
  "uploadInProgress": true,
  "uploadFailedReason": "outOfMemory",
  "fileType": "unknown",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildren": true,
  "pageCount": 1,
  "tokenCount": 1,
  "documentUploadSource": "local",
  "isPackagedFile": true,
  "unpackedFileCount": 1
}

Upload a chunk of a document.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
documentObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Query parameters
chunkIndexinteger · int32Optional
isLastChunkbooleanOptional
uploadFileCountinteger · int32OptionalDefault: 1
ocrEnginestring · enumOptionalPossible values:
ocrStrategystring · enumOptionalPossible values:
coordinateExtractionStrategystring · enumOptionalPossible values:
Body
filestring · binaryOptional
Responses
200

OK

No content
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/partial/{documentObjectIdentifier}
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/partial/{documentObjectIdentifier} 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"
}
200

OK

No content

List folders under a reference material.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Query parameters
parentObjectIdentifierstring · uuidOptional
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
searchTextstringOptional
sortingstring · enumOptionalPossible values:
descbooleanOptionalDefault: true
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/folders
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/folders HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "extension": "text",
    "contentType": "text",
    "size": 1,
    "isDirectory": true,
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "uploadSuccessful": true,
    "uploadInProgress": true,
    "uploadFailedReason": "outOfMemory",
    "fileType": "unknown",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "hasChildren": true,
    "pageCount": 1,
    "tokenCount": 1,
    "documentUploadSource": "local",
    "isPackagedFile": true,
    "unpackedFileCount": 1
  }
]

Create a folder under a reference material.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Body
namestring · nullableRequired
parentObjectIdentifierstring · uuid · nullableOptional
Responses
201

Created

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/folders
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/folders 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"
}
201

Created

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "extension": "text",
  "contentType": "text",
  "size": 1,
  "isDirectory": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "uploadSuccessful": true,
  "uploadInProgress": true,
  "uploadFailedReason": "outOfMemory",
  "fileType": "unknown",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildren": true,
  "pageCount": 1,
  "tokenCount": 1,
  "documentUploadSource": "local",
  "isPackagedFile": true,
  "unpackedFileCount": 1
}

Record a failed document upload.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceMaterialObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
Body
fileNamestring · nullableRequired
uploadFailedReasonstring · enumRequiredPossible values:
documentUploadObjectIdentifierstring · uuidRequired
Responses
201

Created

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/failed
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/failed HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "fileName": "text",
  "uploadFailedReason": "outOfMemory",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
201

Created

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "extension": "text",
  "contentType": "text",
  "size": 1,
  "isDirectory": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "uploadSuccessful": true,
  "uploadInProgress": true,
  "uploadFailedReason": "outOfMemory",
  "fileType": "unknown",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildren": true,
  "pageCount": 1,
  "tokenCount": 1,
  "documentUploadSource": "local",
  "isPackagedFile": true,
  "unpackedFileCount": 1
}

Get a specific document by object identifier.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
extensionstring · nullableOptional
contentTypestring · nullableOptional
sizeinteger · int64 · nullableOptional
isDirectorybooleanOptional
dateAddedstring · date-timeOptional
uploadSuccessfulboolean · nullableOptional
uploadInProgressboolean · nullableOptional
uploadFailedReasonstring · enumOptionalPossible values:
fileTypestring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
hasChildrenboolean · nullableOptional
pageCountinteger · int32 · nullableOptional
tokenCountinteger · int64 · nullableOptional
documentUploadSourcestring · enumOptionalPossible values:
isPackagedFileboolean · nullableOptional
unpackedFileCountinteger · int32 · nullableOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "extension": "text",
  "contentType": "text",
  "size": 1,
  "isDirectory": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "uploadSuccessful": true,
  "uploadInProgress": true,
  "uploadFailedReason": "outOfMemory",
  "fileType": "unknown",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildren": true,
  "pageCount": 1,
  "tokenCount": 1,
  "documentUploadSource": "local",
  "isPackagedFile": true,
  "unpackedFileCount": 1
}

Delete a document.

delete
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Responses
204

No Content

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

No Content

No content

Download a document. Set usePdf=true to download the PDF version instead of the original file.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Query parameters
usePdfbooleanOptionalDefault: false
Responses
200

OK

No content
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/download
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/download HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

No content

Get the breadcrumb trail for a document.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
isDirectorybooleanOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/breadcrumbs
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/breadcrumbs HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "isDirectory": true
  }
]

Get upload batch details.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
uploadObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidRequired
namestring · nullableRequired
dateAddedstring · date-timeOptional
dateCompletedstring · date-time · nullableOptional
totalDocumentCountinteger · int32Optional
failedDocumentCountinteger · int32Optional
processingDocumentCountinteger · int32Optional
completedDocumentCountinteger · int32Optional
totalSizeBytesinteger · int64Optional
fileCountinteger · int32 · nullableOptional
get/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/uploads/{uploadObjectIdentifier}
GET /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/uploads/{uploadObjectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "dateCompleted": "2026-01-01T00:00:00.000Z",
  "totalDocumentCount": 1,
  "failedDocumentCount": 1,
  "processingDocumentCount": 1,
  "completedDocumentCount": 1,
  "totalSizeBytes": 1,
  "fileCount": 1,
  "failedReasonSummary": {
    "outOfMemory": 1,
    "unsupportedFileType": 1,
    "badFile": 1,
    "uploadFailure": 1,
    "ocrPageLimitExceeded": 1,
    "unknownException": 1,
    "insufficientCredits": 1,
    "maliciousFile": 1,
    "fileScanTimedOut": 1
  },
  "fileTypeSummary": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Reindex a document.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Body
Responses
200

OK

No content
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/reindex
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/reindex HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "uploadSettings": {
    "ocrEngine": "azureDocumentIntelligence",
    "ocrStrategy": "never",
    "coordinateExtractionStrategy": "never"
  }
}
200

OK

No content

Retry failed documents in an upload batch.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
uploadObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Body
Responses
200

OK

No content
post/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/uploads/{uploadObjectIdentifier}/retry
POST /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/uploads/{uploadObjectIdentifier}/retry HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "uploadSettings": {
    "ocrEngine": "azureDocumentIntelligence",
    "ocrStrategy": "never",
    "coordinateExtractionStrategy": "never"
  }
}
200

OK

No content

Move documents to a new parent folder.

put
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
referenceMaterialObjectIdentifierstringRequired
Body
newParentObjectIdentifierstring · uuidRequired
documentObjectIdentifiersstring · uuid[] · nullableRequired
Responses
200

OK

No content
put/playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/move
PUT /playbooks/{playbookIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/move HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "newParentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
200

OK

No content
PreviousPlaybook Reference Materials
NextPlaybook Assembly Download

Last updated