Sign in
assets
public

Get Assets

Retrieve asset IDs from a project.

Parameters:

  • asset_ids (List[str], optional): The list of asset IDs to retrieve. This is optional, but will override the proj_id if provided.
  • proj_id (str, optional): The id of the project. This is optional, but will be used if asset_ids is not provided.
  • status (AssetStatus, optional): Filters the results based on the status of the assets.
  • limit (int, optional): The number of transformations to retrieve.
  • offset (int, optional): The offset to start retrieving transformations from.
  • order_by (str, optional): The column to order the transformations by.
  • order (str, optional): The order to sort the transformations by.

If neither asset_ids or proj_id is provided, all assets will be retrieved.

Returns:

  • dict: A dict containing the all the asset data.
get/v1/assets

Query parameters

asset_idsstring[]

List of asset IDs to retrieve.

List of asset IDs to retrieve.

proj_idstring

The id of the project.

The id of the project.

transform_idstring

The id of the transformation.

The id of the transformation.

row_idstring

Row ID where the asset belongs

Row ID where the asset belongs

operation_idstring

Operation ID where the asset belongs

Operation ID where the asset belongs

entity_idstring

Entity ID where the asset belongs

Entity ID where the asset belongs

entity_field_idstring

Entity field ID where the asset belongs

Entity field ID where the asset belongs

status'uploading' | 'uploaded' | 'failed_upload' | 'processing' | 'not_processed' | 'processed'

An enumeration.

The status of the assets to retrieve.

limitinteger
offsetinteger
order_by'updated_at' | 'created_at' | 'id'

An enumeration.

order'asc' | 'desc'

An enumeration.

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

Response

Successful Response

messagestring required

Changes

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