Axelered
Documents

Update Document

PATCH
/documents/{document_id}

Update the name of a document. The file itself cannot change.

Path Parameters

document_id*Document Id
Formatuuid

Header Parameters

x-workspace-id?|

The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.

Request Body

application/json
  1. body
name?Name

New name of the document

Length1 <= length <= 255

Response Body

Successful Response

application/json
  1. response
status?Status
Default"ok"
data*
{  "status": "ok",  "data": {    "id": "string",    "workspaceId": "string",    "createdAt": "string",    "modifiedAt": "string",    "deletedAt": "string",    "name": "string",    "mimeType": "text/plain",    "size": 0  }}

Read Document GET

Read the metadata of a document.

Submit Parsing POST

Submit a Parsing. Pass `documentId` for an uploaded Document, or `file` to upload it in the same call. Returns 200 when the Parsing finishes within `wait`, 202 otherwise.