Make an uploaded file the document's file

POST

/api/v1/documents/{id}/file/commit

If the document has no text, the file's text is extracted at once and reported in extracted.

App integration: Call after the storage PUT succeeds. Use the matching uploadId, name, type and byte length and the latest If-Match revision. Inspect extracted: a successful commit can still report an extraction error while retaining the original file.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://handwrites.io/oauth/authorize

Token URL: https://handwrites.io/api/oauth/token

Refresh URL: https://handwrites.io/api/oauth/token

Scopes:

documents:write-Create documents, edit them and upload their files

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The new revision.

Headers

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠409Conflict

🟠412PreconditionFailed

🟠422Unprocessable

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/documents//file/commit' \
--header 'If-Match;' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "type": "application/pdf",
    "length": 1,
    "uploadId": "string"
}'

Response Example

200 - Example 1

{
    "id": "doc_Ab3dEf6hIj9kLm0n",
    "title": "string",
    "language": "en",
    "revision": 0,
    "contentType": "text/plain",
    "contentLength": 0,
    "contentSha256": "string",
    "file": {
        "name": "string",
        "type": "application/pdf",
        "length": 0
    },
    "owner": "user:3f2b…",
    "access": "owner",
    "source": "api",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "extracted": {
        "characters": 0,
        "method": "text"
    }
}

Modified at 2026-10-26 12:58:15

Start uploading the original file

Replace the text with the file's text