Document Uploads

Retrieves a paginated list of document upload records for the specified project.

get

Retrieves a paginated list of document upload records for the specified project, optionally filtered and sorted.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter document uploads.

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

403

Forbidden

text/plainapplication/jsontext/json

get

/projects/{projectIdentifier}/document-uploads

HTTPcURLJavaScriptPython

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

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

Creates a new document upload record for the specified project.

post

Creates a new document upload record for the specified project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

isCompletedbooleanRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/projects/{projectIdentifier}/document-uploads

HTTPcURLJavaScriptPython

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: 34

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

application/jsontext/jsonapplication/*+json

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

Retrieves a document upload record by its object identifier.

get

Retrieves a document upload record by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document upload record.

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

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

HTTPcURLJavaScriptPython

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

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

Updates a document upload record by its object identifier.

patch

Updates a document upload record by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the document upload record to update.

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

isCompletedbooleanRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

patch

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

HTTPcURLJavaScriptPython

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: 34

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

application/jsontext/jsonapplication/*+json

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