Files

Upload a small file in one request

Upload a file in one multipart/form-data request.

Request bodies over 4.5 MB are rejected at the platform edge before they reach this route. For larger files, create an upload URL and PUT the bytes to it instead; the SDK's files.upload() does that for files of any size. The Upload files guide walks through both flows.

At least one of job_execution_id and instrument_id is required: pass a job_execution_id for an artifact of a job running in a sandbox, which also records provenance linking the file to that execution, and pass an instrument_id for data captured off-platform by an instrument the Sync app cannot reach, which attaches the file to that instrument so instrument triggers and parsers pick it up.

Requires an API key with the write scope.

post/api/v1/files

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/files
  • Auth: HTTP bearer

Response

OK

file_idstring required

The ID of the uploaded file.

file_namestring required

The original file name.

size_kilobytesinteger nullable required

File size in kilobytes.

Changes

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