API DocumentationProduct Documentation

Cloud Data Connector File Upload

post https://api.tetrascience.com/v1/uda/upload

This endpoint uploads a file to TetraScience Cloud. It requires a Cloud Data Connector (CDC) (Formerly known as a User-Defined Integration) and 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. when dataCategory param is batch, param filePath must be provided
  3. when dataCategory param is stream, param fileName must be provided
  4. when fileCategory param is IDS, param ids must be provided in valid IDS form or IDS schema does not exist. Uploaded file must be valid IDS file for given IDS schema
  5. param sourceType must contain only lower case alphanumerical characters and dashes
  6. params metadata and tags must contain only ASCII characters; tags values cannot contain comma and values must be unique
  7. params metadata and tags together as JSON objects must have less than 1.5KB of text (1536 characters)

Error response examples

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "child \"agentId\" fails because [\"agentId\" must be a valid GUID]",
    "validation": {
        "source": "payload",
        "keys": [
            "agentId"
        ]
    }
}
Language
Authorization
Click Try It! to start a request and see the response here!