Upload Assets

post/v1/assets/upload

Headers

API-Versionstring

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).

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).

Request body

proj_idstring

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

transform_idstring

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

entity_idstring

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

urlsstring[] required

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

file_typesstring[]

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

ext_idsstring[]

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

ext_file_namesstring[]

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

chunk_strategystring

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_headerboolean

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

main_keysstring[]

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_typestring

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

parse_strategystring

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

process_with_workflowboolean

Optional. If true, the assets will be processed with the workflow configured on your project.

Example request

{
  "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"
    }
  ]
}

Response

Successful Response

messagestring required

Changes

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