import_annotations

Bulk-import a list of annotations onto an asset.

import_annotations

Bulk-import a list of annotations onto an asset.

Safety class: A · API type: portal · Min version:

📘

Confinement

asset_id must be within your run-root anchor; the annotations live on that asset.

Signatures

def import_annotations(sdk, asset_id, annotations):
    """Bulk-import a list of annotation dicts onto asset_id (returns None)."""
    return sdk.import_annotations(asset_id, annotations)
export async function importAnnotations(sdk, assetId, annotations) {
    // Bulk-import an array of annotation objects onto assetId.
    return await sdk.importAnnotations(assetId, annotations);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
asset_idassetIdstryese.g. <asset-uuid>
annotationsannotationslist[dict]yese.g. [{"startTimeCode": "00:00:00;00", "title": "a"}]

Returns

None — returns None; confirm via get_annotations.

Errors

  • 401 unauthenticated
  • 404 asset not found

See also: Python ↔ JS naming map · Return shapes.