get_assets

imerit_ango.sdk.SDK.

get_assets(project_id, page, limit, filters)

Retrieve assets from your project.

Parameters

• project_id: string

  • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

• page: integer, default 1

  • The page number for paginated results.

• limit: integer, default 10

  • The maximum number of assets to return per page.

• filters: dict, default {}

  • A dictionary of filter options. If omitted, all assets will be returned.

  • Here is a list of possible filters you may pass in the filters dict:

{
    "_id": ["asset_id_1", "asset_id_2"],                  # Asset ID filter
    "externalId": ["external_id_1", "external_id_2"],     # External ID filter
    "isPreLabeled": bool,                                 # Prelabel filter
    "batches": ["batch_id_1", "batch_id_2"],              # Batch filter (only the assets belonging to all batches will be returned) This is an "AND" operation.
    "createdAt": {"gt": "ISO_TIME_STR"},                  # gt: Greater Than (after), ISO_TIME_STR example: "2002-12-09T00:00:00.000Z"
    "createdAt": {"lt": "ISO_TIME_STR"}                   # lt: Less Than (before), ISO_TIME_STR example: "2002-12-09T00:00:00.000Z"
}

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

Example

Retrieve the first ten assets from the project:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

sdk_response = ango_sdk.get_assets(project_id=project_id)

data_url = sdk_response['data']['assets'][0]['data']
external_id = sdk_response['data']['assets'][0]['externalId']

curl

Retrieve all assets from the project:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

page = 1
num_assets = 1
asset_list = []
while len(asset_list) < num_assets:
    response = ango_sdk.get_assets(project_id=project_id, page=page, limit=50)
    assets = response.get('data', {}).get('assets', [])
    num_assets = response.get('data', {}).get('total', 0)

    asset_list.extend(assets)
    page += 1

print("The number of retrieved assets is: " + str(len(asset_list)))

Retrieve a single asset via asset ID:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

asset_id = 'YOUR_ASSET_ID'

ango_sdk = SDK(api_key)

sdk_response = ango_sdk.get_assets(project_id=project_id, filters={"_id": [asset_id]})

data_url = sdk_response['data']['assets'][0]['data']
external_id = sdk_response['data']['assets'][0]['externalId']

curl

See also

get_task, get_tasks