auto_annotate_start
Start an automated annotation run that labels a dataset using a model's predictions. Provide dataset and model references, and set confirm_cost=true to proceed with the credit-costing operation.
Instructions
Start an auto-annotation run on a dataset by slug, owner/slug, or a ul://owner/datasets/slug URI, labelling it with a model given by owner/project/model, ul://owner/project/model, or slug with a project (state-changing, billable, may cost credits). Requires confirm_cost=true: there is no cost preview, no published rate, and a 402 signals insufficient credits; gauge magnitude with datasets_get (the unlabeled image count by default, the total count when include_annotated is true). Sends only modelId plus any of confidence, iou, class_mapping, and include_annotated the caller sets explicitly, omitting the rest so the server's own defaults (confidence 0.25, iou 0.7, include_annotated false, illustrative only) apply undisturbed. There is no imgsz parameter. class_mapping bridges a model/dataset class-taxonomy mismatch (for example a 1-class model against an 80-class dataset, which otherwise fails outright); it passes through with no length check. Labels are additive, never overwritten, so no overwrite confirmation is needed. Every start snapshots a dataset version before labelling, listed via datasets_get and undoable exactly with dataset_version_restore. Billing settles at run time, not at dismissal, so auto_annotate_stop does not refund a charge already incurred. Use auto_annotate_status to poll and auto_annotate_stop to cancel.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iou | No | IoU threshold for generated labels. Omit to use the server default (currently 0.7). | |
| model | Yes | Model ref by owner/project/model, ul:// URI, or slug (requires project). | |
| dataset | Yes | Dataset ref by slug, owner/slug, or a ul://owner/datasets/slug URI. | |
| project | No | Project ref required when model is given by slug. | |
| confidence | No | Confidence threshold for generated labels. Omit to use the server default (currently 0.25). | |
| confirm_cost | No | Must be true to allow a credit-costing auto-annotation run. | |
| class_mapping | No | Model class index -> dataset class index mapping, positioned by model class index. Required to bridge a class-taxonomy mismatch between the model and the dataset; passed through with no length check. | |
| include_annotated | No | Re-label images that already carry annotations. Omit to use the server default (currently false). |