list_annotations
Retrieve annotations from a dataset using filters for image, category, annotation type, and IDs, with pagination support.
Instructions
List annotations with stable filters and pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Zero-based result offset. | |
| dataset_id | Yes | Owning dataset identifier. | |
| image_path | No | Optional dataset-relative image filter. | |
| max_results | No | Positive page size. | |
| category_ids | No | Optional category identifiers to include. | |
| annotation_ids | No | Optional annotation identifiers to include. | |
| annotation_type | No | Optional geometry type filter or ``all``. | |
| include_deleted_categories | No | Whether deleted-category records are shown. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | ||
| data | Yes | Contain one page of annotation records and stable paging metadata. |