ONonecodex

Deprecated in favour of init_multipart_upload

post/api/v1/documents/init_upload

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/documents/init_upload
  • Auth
    API key in header X-API-Key

Request body

filenamestring required

The filename of the document to be uploaded, optionally gzipped (and ending in .gz or .gzip). Filenames should only contain alphanumeric characters, dashes, underscores, and periods.

sizeinteger required

The size of the file in bytes.

Response

OK

additional_fieldsobject required

Additional fields to include in the upload.

document_idstring required

The document_id of the uploaded document.

upload_urlstring required

The URL to POST the document to.

Changes

No recorded changes to this operation across all 2 revisions of this API.