POST
/
v1
/
assets
/
upload
curl --request POST \
  --url https://api.runtrellis.com/v1/assets/upload \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "proj_id": "<string>",
  "transform_id": "<string>",
  "urls": [
    "<string>"
  ],
  "file_types": [
    "<string>"
  ],
  "ext_ids": [
    "<string>"
  ],
  "ext_file_names": [
    "<string>"
  ],
  "chunk_strategy": "<string>",
  "include_header": true,
  "main_keys": [
    "<string>"
  ],
  "file_type": "<string>",
  "parse_strategy": "<string>",
  "cells": [
    {
      "row_id": "your-first-row-id",
      "op_id": "your-first-operation-id"
    },
    {
      "row_id": "your-second-row-id",
      "op_id": "your-second-operation-id"
    },
    {
      "row_id": "your-third-row-id",
      "op_id": "your-third-operation-id"
    }
  ]
}'
{
  "message": "<string>",
  "metadata": {
    "total_results_count": 123,
    "total_filtered_results_count": 123
  },
  "data": [
    {
      "asset_id": "<string>",
      "ext_file_name": "<string>",
      "ext_file_id": "<string>",
      "file_type": "<string>",
      "url": "<string>",
      "status": "uploading",
      "proj_id": "<string>",
      "transform_id": "<string>",
      "entity_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
API-Version
string

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Body

application/json
​
urls
string[]
required

A list of file URLs to be downloaded and processed during the upload.

​
proj_id
string

The ID of the project to which the assets will be uploaded and assigned.

​
transform_id
string

Specify if the uploaded assets should be processed exclusively by a particular transformation.

​
file_types
string[]

Optional. Specify the file types for each URL (e.g., 'csv', 'xlsx'). If not provided, defaults will be used based on content.

​
ext_ids
string[]

Optional. External identifiers for the files, useful for mapping or reference.

​
ext_file_names
string[]

Optional. Names for the files to be uploaded. If not provided, names will be derived from the URLs.

​
chunk_strategy
string

Optional. Define how files should be split during processing. Supported values are new_line (split rows by newline for CSV/Excel) or None (no splitting).

​
include_header
boolean
default:true

Specify whether the input files include a header row. This applies to CSV or Excel files only.

​
main_keys
string[]

Optional. Column names to be used as unique identifiers when chunking data. If not provided, all columns will be combined to generate unique identifiers.

​
file_type
string

Default file type to apply to all files if individual types are not specified.

​
parse_strategy
string

Optional. Strategy to be used for parsing files during processing.

​
cells
object[]

Optional. If provided, must also provide transform_id. Additionally, every url required a cell to upload the file into.

Example:
[
  {
    "row_id": "your-first-row-id",
    "op_id": "your-first-operation-id"
  },
  {
    "row_id": "your-second-row-id",
    "op_id": "your-second-operation-id"
  },
  {
    "row_id": "your-third-row-id",
    "op_id": "your-third-operation-id"
  }
]

Response

200
application/json
Successful Response
​
message
string
required
​
data
object[]
required
​
metadata
object