create_annotation
Add a time-coded annotation to an asset.
create_annotation
Add a time-coded annotation to an asset.
Safety class: A · API type: portal · Min version: —
Confinementasset_id must be within your run-root anchor; the annotation lives on that asset.
Signatures
def create_annotation(sdk, asset_id, start_time_code, end_time_code,
title=None, summary=None, description=None):
"""Add a time-coded annotation to asset_id; return the created annotation."""
return sdk.create_annotation(asset_id, start_time_code, end_time_code,
title, summary, description)export async function createAnnotation(sdk, assetId, startTimeCode, endTimeCode,
title = null, summary = null, description = null) {
// Add a time-coded annotation to assetId.
return await sdk.createAnnotation(assetId, startTimeCode, endTimeCode, title, summary, description);
}Parameters
| Parameter (Python) | Parameter (JS) | Type | Required | Notes |
|---|---|---|---|---|
sdk | sdk | Nomad_SDK | yes | |
asset_id | assetId | str | yes | e.g. <asset-uuid> |
start_time_code | startTimeCode | str | yes | e.g. 00:00:00;00 |
end_time_code | endTimeCode | str | yes | e.g. 00:00:01;00 |
title | title | str | null | no | |
summary | summary | str | null | no | |
description | description | str | null | no |
Returns
dict | None — the created annotation (incl. its id). None on failure.
Errors
- 401 unauthenticated
- 404 asset not found
See also: Python ↔ JS naming map · Return shapes.
