delete_annotation

Delete an annotation from an asset.

delete_annotation

Delete an annotation from an asset.

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

📘

Confinement

asset_id must be within your run-root anchor; only deletes the annotation on it.

Signatures

def delete_annotation(sdk, asset_id, annotation_id):
    """Delete one annotation from asset_id."""
    return sdk.delete_annotation(asset_id, annotation_id)
export async function deleteAnnotation(sdk, assetId, annotationId) {
    // Delete one annotation from assetId.
    return await sdk.deleteAnnotation(assetId, annotationId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
asset_idassetIdstryese.g. <asset-uuid>
annotation_idannotationIdstryese.g. <annotation-uuid>

Returns

dict | None — confirmation on success; None on failure.

Errors

  • 401 unauthenticated
  • 404 asset or annotation not found

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