Skip to main content
POST
/
api
/
v1
/
documents
/
confirm_upload
POST documents confirm_upload
curl --request POST \
  --url https://app.onecodex.com/api/v1/documents/confirm_upload \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_id": "<string>"
}
'
{
  "document": {
    "type": "<unknown>",
    "pattern": "<unknown>"
  },
  "message": "<string>",
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

Confirms the upload. See Starting an Upload for more details on the full upload workflow.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
document_id
string
required

The document_id returned by /documents/init_upload. Note that the document will not be accessible via /documents/<id> until the upload is confirmed.

Response

200 - application/json

Successful operation

​
document
object

A reference to the uploaded document.

​
message
string

A success or error message.

​
success
boolean

Whether the upload was successful.