Document Uploads

List a project's document uploads.

get

Retrieves a paginated list of document uploads for the project, optionally filtered by search text and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

totalCountinteger · int32Optional

403

Forbidden

get/projects/{projectIdentifier}/document-uploads

GET /projects/{projectIdentifier}/document-uploads HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "fileCount": 1,
      "name": "text",
      "ocrEngine": "azureDocumentIntelligence",
      "ocrStrategy": "never",
      "coordinateExtractionStrategy": "never",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "dateCompleted": "2026-01-01T00:00:00.000Z",
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    }
  ],
  "totalCount": 1
}

Create a document upload record.

post

Starts a new document upload for the project and returns the upload record used to track the documents being added.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

fileCountinteger · int32 · nullableOptional

namestring · nullableRequired

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

Responses

200

OK

fileCountinteger · int32 · nullableOptional

namestring · nullableRequired

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

objectIdentifierstring · uuidRequired

dateAddedstring · date-timeOptional

dateCompletedstring · date-time · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

post/projects/{projectIdentifier}/document-uploads

POST /projects/{projectIdentifier}/document-uploads HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "fileCount": 1,
  "name": "text",
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never"
}

{
  "fileCount": 1,
  "name": "text",
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "dateCompleted": "2026-01-01T00:00:00.000Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Get a document upload by identifier.

get

Retrieves the full details of a single document upload in the project by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

namestring · nullableRequired

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

dateCompletedstring · date-time · nullableOptional

totalDocumentCountinteger · int32Optional

failedDocumentCountinteger · int32Optional

processingDocumentCountinteger · int32Optional

completedDocumentCountinteger · int32Optional

totalSizeBytesinteger · int64Optional

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

totalCreditsCostnumber · double · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

get/projects/{projectIdentifier}/document-uploads/{objectIdentifier}

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

{
  "name": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateCompleted": "2026-01-01T00:00:00.000Z",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  },
  "totalDocumentCount": 1,
  "failedDocumentCount": 1,
  "processingDocumentCount": 1,
  "completedDocumentCount": 1,
  "totalSizeBytes": 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
  },
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never",
  "totalCreditsCost": 1
}

Update a document upload.

patch

Marks a project's document upload as completed and notifies project admins that the documents have been added.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

fileCountinteger · int32 · nullableOptional

namestring · nullableRequired

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

Responses

200

OK

fileCountinteger · int32 · nullableOptional

namestring · nullableRequired

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

objectIdentifierstring · uuidRequired

dateAddedstring · date-timeOptional

dateCompletedstring · date-time · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch/projects/{projectIdentifier}/document-uploads/{objectIdentifier}

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

{
  "fileCount": 1,
  "name": "text",
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never"
}

{
  "fileCount": 1,
  "name": "text",
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "dateCompleted": "2026-01-01T00:00:00.000Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}