Skip to content
REST API

Complete a file upload

POST
/files/{fileId}/complete

Checks that the upload reached storage and starts extracting the file's text. Poll GET /files/{fileId} until status is ready or failed. Calling it again while the file is parsing returns the same job.

Required scopes: files:upload

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

fileId*string

Note file id, scoped to the key's user.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/complete"
{  "data": {    "id": "3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a9f",    "status": "parsing",    "jobId": "7a6b5c4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d"  }}