Documents

Retrieves a paginated list of documents for the specified project.

get

Retrieves a paginated list of documents for the specified project, optionally filtered and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

parentObjectIdentifierstring · uuidOptional

The parent folder's object identifier (optional).

flattenListbooleanOptional

Whether to flatten the folder structure.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter documents.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

403

Forbidden

get

/projects/{projectIdentifier}/documents

GET /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
    "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 document to the specified project.

post

Uploads a new document to the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

The parent folder's object identifier (optional).

documentUploadIdentifierstring · uuidRequired

The unique identifier for the document upload session.

Body

filestring · binaryOptional

The file to upload.

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/documents

POST /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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 document record in the specified project.

post

Creates an empty document record in the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

The parent folder's object identifier (optional).

fileNamestringRequired

The name of the file.

contentTypestringRequired

The content type of the file.

documentUploadIdentifierstring · uuidRequired

The unique identifier for the document upload session.

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/documents/empty

POST /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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 document.

post

Appends a chunk to a partially uploaded document.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired

Query parameters

chunkIndexinteger · int32Optional

The index of the chunk.

lastChunkbooleanOptional

Whether this is the last chunk.

Default: false

Body

filestring · binaryOptional

The file chunk to append.

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/documents/{objectIdentifier}/append-chunk

POST /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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 a new folder in the specified project.

post

Creates a new folder in the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/documents/folder

POST /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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 document file by its object identifier.

get

Downloads a document file by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired

Responses

200

Responsestring · binary

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/documents/{objectIdentifier}/download

GET /projects/{projectIdentifier}/documents/{objectIdentifier}/download HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Downloads a document file stream by its object identifier.

get

Downloads a document file stream by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired

Responses

200

Responsestring · binary

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/documents/{objectIdentifier}/download-stream

GET /projects/{projectIdentifier}/documents/{objectIdentifier}/download-stream HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Downloads a document file stream by its object identifier.

head

Downloads a document file stream by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired

Responses

200

Responsestring · binary

403

Forbidden

404

Not Found

head

/projects/{projectIdentifier}/documents/{objectIdentifier}/download-stream

HEAD /projects/{projectIdentifier}/documents/{objectIdentifier}/download-stream HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieves a document by its object identifier.

get

Retrieves a document by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired

Responses

200

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/documents/{objectIdentifier}

GET /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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 document by its object identifier.

put

Updates a document by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document to update.

projectIdentifierstringRequired

Body

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/documents/{objectIdentifier}

PUT /projects/{projectIdentifier}/documents/{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": "2026-01-27T17:28:23.426Z",
  "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 document by its object identifier.

delete

Deletes a document by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document to delete.

projectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

delete

/projects/{projectIdentifier}/documents/{objectIdentifier}

DELETE /projects/{projectIdentifier}/documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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.

projectIdentifierstringRequired

Body

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/documents/folder/{objectIdentifier}

PUT /projects/{projectIdentifier}/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": "2026-01-27T17:28:23.426Z",
  "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"
  }
}

PreviousDocument Uploads NextFlow Columns

Last updated 6 months ago

hashtagRetrieves a paginated list of documents for the specified project.

hashtagUploads a new document to the specified project.

hashtagCreates an empty document record in the specified project.

hashtagAppends a chunk to a partially uploaded document.

hashtagCreates a new folder in the specified project.

hashtagDownloads a document file by its object identifier.

hashtagDownloads a document file stream by its object identifier.

hashtagDownloads a document file stream by its object identifier.

hashtagRetrieves a document by its object identifier.

hashtagUpdates a document by its object identifier.

hashtagDeletes a document by its object identifier.

hashtagUpdates a folder by its object identifier.

Retrieves a paginated list of documents for the specified project.

Uploads a new document to the specified project.

Creates an empty document record in the specified project.

Appends a chunk to a partially uploaded document.

Creates a new folder in the specified project.

Downloads a document file by its object identifier.

Downloads a document file stream by its object identifier.

Downloads a document file stream by its object identifier.

Retrieves a document by its object identifier.

Updates a document by its object identifier.

Deletes a document by its object identifier.

Updates a folder by its object identifier.