Uploads

Complete a file's upload

Finalises one file from the ETags of its uploaded parts. Call it once per file. A file that is already complete returns success again, so a retry after a dropped connection is safe.

Rate limit: 600 requests per minute per API key, shared by the upload endpoints.

post/uploads/sessions/{upload_session_id}/complete

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/uploads/sessions/{upload_session_id}/complete
  • Auth: HTTP bearer

Path parameters

upload_session_idstring required

An identifier you choose: 1 to 200 characters from letters, digits, dots, underscores, colons and hyphens. Used for upload_session_id, file_id and submission_id.

The upload_session_id you chose when creating the session.

Request body

file_idstring required

An identifier you choose: 1 to 200 characters from letters, digits, dots, underscores, colons and hyphens. Used for upload_session_id, file_id and submission_id.

Response

The file is complete and can be named in an extraction.

successtrue required
upload_session_idstring required

An identifier you choose: 1 to 200 characters from letters, digits, dots, underscores, colons and hyphens. Used for upload_session_id, file_id and submission_id.

file_idstring required

An identifier you choose: 1 to 200 characters from letters, digits, dots, underscores, colons and hyphens. Used for upload_session_id, file_id and submission_id.

file_namestring required
status'completed'

Present when this call completed the file; absent when the file was already complete.

Changes

No recorded changes to this operation across all 1 revision of this API.