Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Data Acquisition

File Upload

This endpoint uploads a file to TetraScience Cloud. It requires a user-defined agent set up in the TetraScience Web UI. API users can use it to upload, manage their files, and trigger pipelines.

Maximum payload size: 500MB

Validations performed by this endpoint:

  1. agentId must be a valid ID of the user defined agent (UDA)
  2. param sourceType must contain only lower case alphanumerical characters and dashes
  3. params metadata and tags must contain only ASCII characters; tags values cannot contain comma and values must be unique
  4. params metadata and tags together as JSON objects must have less than 1.5KB of text (1536 characters)
post/v1/data-acquisition/agent/upload

Response

200

typestring
fileKeystring
bucketstring
versionstring
fileIdstring

Example response

{
  "type": "s3file",
  "fileKey": "demo/1cd9ffeb-1e10-45d2-a8d6-61a88c829e5c/RAW/test/raw.json",
  "bucket": "ts-platform-env-datalake",
  "version": "grXOL0hSiCeKu094tBw.mu4LXQErWzGT",
  "fileId": "c4c6cfdf-67d0-4672-a1a6-0b9f558d0156"
}