Assets

Download and manage order assets using the API.


Overview

Assets are data from completed tasking and catalog orders that you can download. Assets from storage can be used as input imagery for processing.

Find assets

The following order statuses mean you can download assets from storage:

  • BEING_FULFILLED: some order assets might have been delivered.
  • FULFILLED: all order assets have been delivered.

To get a list of assets with their IDs, call the Get assets endpoint. There are different query parameters you can specify for your search. For example:

TaskEndpoint with query parameters
Get all assets from a specific orderhttps://api.up42.com/v2/assets?
search=a0d443a2-41e8-4995-8b54-a5cc4c448227
Get all assets with the “optical” taghttps://api.up42.com/v2/assets?tags=optical
Get all CNAM-compatible assets from your storagehttps://api.up42.com/v2/assets?
geospatialMetadataExtractionStatus=SUCCESSFUL

CNAM transformation status

The status of the CNAM transformation or geospatial metadata extraction indicates the progress and outcome of transforming the asset’s metadata for CNAM compatibility. Only transformed assets can be accessed through Data management inline-icon Data managementMap.

StatusDescription
SUCCESSFULThe transformation process was successful, and the asset is CNAM-compatible.
IN_PROGRESSThe transformation process for the asset is currently ongoing.
NOT_PROCESSEDThe asset hasn’t undergone any transformation process.
FAILEDThe transformation process failed for the asset.

Download assets

To download these assets one by one, call the Download an asset endpoint with the chosen asset ID as the path parameter. If the request is successful, the response will be the requested asset.

You can also generate a pre-signed URL to download an asset without authentication. Call the Create a download URL endpoint with the asset ID as the path parameter. The generated URL is valid for 5 minutes and can be shared. It will have the following format:

JSON

    {
  "url": "https://storage.googleapis.com/user-storage-interstellar-prod/assets/<...>"
}

  

Stream assets

To get a streaming link for transformed assets, use STAC API endpoints as follows:

  1. Find a STAC item containing a geospatial feature you want to stream. To search for STAC items with specific parameters across your storage, call the Get specific STAC items endpoint with your search parameters in the request body.

  2. Inside a STAC item, view the assets parameter containing STAC assets:

    JSON

        {
      <...>,
      "type": "FeatureCollection",
      "features": [
        {
          "assets": {
            "aot.tiff": {
              "href": "https://api.up42.com/v2/assets/a0d443a2-41e8-4995-8b54-a5cc4c448227",
              "title": "Aerosol optical thickness",
              "description": null,
              "type": "image/tiff; application=geotiff; profile=cloud-optimized",
              "roles": [
                "data"
              ]
            },
            "b01.tiff": {
              "href": "https://api.up42.com/v2/assets/55434287-31bc-3ad7-1a63-d61aac11ac55",
              "title": "Costal aerosol band",
              "description": null,
              "type": "image/tiff; application=geotiff; profile=cloud-optimized",
              "roles": [
                "data"
              ]
            }
          }
        }
      ],
      <...>
    }
    
      
  3. Find the STAC assets you want to stream and extract their IDs from the nested assets.<asset-name>.href parameter. For example:

    Text

        "href": "https://api.up42.com/v2/assets/a0d443a2-41e8-4995-8b54-a5cc4c448227"
    ↓
    STAC asset ID: a0d443a2-41e8-4995-8b54-a5cc4c448227
    
      
  4. To get a streaming link, call the Create a download URL endpoint with the chosen STAC asset ID as the path parameter. The response will have the following format:

    JSON

        {
      "url": "https://storage.googleapis.com/user-storage-interstellar-prod/assets/<...>"
    }
    
      
  5. Paste the streaming link into a third-party application or visualization software — for example, QGIS.

Manage assets

To check a single asset’s metadata, call the Get asset metadata endpoint with the chosen asset ID as the path parameter.

To update the title or tags of a storage asset, call the Update asset metadata endpoint with the asset ID as the path parameter and the new values in the request body, for example:

JSON

    {
  "title": "SPOT 6/7 NY Central Park",
  "tags": ["optical", "berlin"]
}