Playbook Source Documents

Gets playbook source documents by container.

get

Retrieves playbook source documents for a container with optional filtering and pagination.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for pagination.

parentObjectIdentifierstring · uuidOptional

The optional parent object identifier.

flattenListbooleanOptional

Whether to flatten the list.

pageSizeinteger · int32Optional

The page size for pagination.

searchTextstringOptional

The search text to filter documents.

sortinginteger · enumOptional

The sorting option.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

400

Bad Request

403

Forbidden

get

/playbooks/{playbookIdentifier}/source-documents

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

{
  "items": [
    {
      "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:17:41.422Z",
      "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"
      }
    }
  ],
  "totalCount": 1
}

Creates a new playbook source document.

post

Creates a new playbook source document by uploading a file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

The optional parent object identifier.

documentUploadIdentifierstring · uuidRequired

The unique identifier for the document upload.

Body

filestring · binaryOptional

The file to upload.

Responses

201

Created

400

Bad Request

403

Forbidden

post

/playbooks/{playbookIdentifier}/source-documents

POST /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 playbook source document.

post

Creates an empty playbook source document with specified file name and content type.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

The optional parent object identifier.

fileNamestringRequired

The name of the file.

contentTypestringRequired

The content type of the file.

documentUploadIdentifierstring · uuidRequired

The unique identifier for the document upload.

Responses

201

Created

400

Bad Request

403

Forbidden

post

/playbooks/{playbookIdentifier}/source-documents/empty

POST /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 playbook source document upload.

post

Uploads a file chunk to an existing playbook source document.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

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 upload.

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

post

/playbooks/{playbookIdentifier}/source-documents/{objectIdentifier}/append-chunk

POST /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 playbook source document by its object identifier.

get

Retrieves a playbook source document by its unique identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

playbookIdentifierstringRequired

Responses

200

403

Forbidden

404

Not Found

get

/playbooks/{playbookIdentifier}/source-documents/{objectIdentifier}

GET /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 a playbook source document by its object identifier.

put

Updates a playbook source document by its unique identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document to update.

playbookIdentifierstringRequired

Body

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuidRequired

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/playbooks/{playbookIdentifier}/source-documents/{objectIdentifier}

PUT /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 playbook source document by its object identifier.

delete

Deletes a playbook source document by its unique identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document to delete.

playbookIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

delete

/playbooks/{playbookIdentifier}/source-documents/{objectIdentifier}

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

No content

Adds a folder to the playbook source documents.

post

Creates a new folder within the playbook source documents.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

Responses

201

Created

400

Bad Request

403

Forbidden

post

/playbooks/{playbookIdentifier}/source-documents/folder

POST /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 a folder by its object identifier.

put

Updates a folder by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the folder to update.

playbookIdentifierstringRequired

Body

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/playbooks/{playbookIdentifier}/source-documents/folder/{objectIdentifier}

PUT /playbooks/{playbookIdentifier}/source-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:17:41.422Z",
  "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 playbook source document file by its object identifier.

get

Downloads the file for a playbook source document by its unique identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document to download.

playbookIdentifierstringRequired

Responses

200

Responsestring · binary

403

Forbidden

404

Not Found

get

/playbooks/{playbookIdentifier}/source-documents/{objectIdentifier}/download

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

binary

PreviousPlaybook Source Document Uploads NextPlaybook Test Document Uploads

Last updated 4 months ago