GET
/
v1
/
assets
Get Assets
curl --request GET \
  --url https://api.runtrellis.com/v1/assets \
  --header 'Authorization: <api-key>'
{
  "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).

Query Parameters

​
asset_ids
string[]

List of asset IDs to retrieve.

​
proj_id
string

The id of the project.

​
transform_id
string

The id of the transformation.

​
row_id
string

Row ID where the asset belongs

​
operation_id
string

Operation ID where the asset belongs

​
status
enum<string>

The status of the assets to retrieve. An enumeration.

Available options:
uploading,
uploaded,
failed_upload,
processing,
not_processed,
processed
​
limit
integer
default:20
Required range: x > 0
​
offset
integer
default:0
Required range: x >= 0
​
order_by
enum<string>
default:updated_at

An enumeration.

Available options:
updated_at,
created_at,
id
​
order
enum<string>
default:desc

An enumeration.

Available options:
asc,
desc

Response

200
application/json

Successful Response

The response is of type object.