Platform Guides

Guidelines

Author, version, and validate the annotation guidelines that annotators follow.

Overview

Guidelines are the rulebook annotators consult while labeling. A guideline is built from sections, labels, and worked examples. Every edit produces a revision, and validations plus ambiguity flags catch unclear rules before they reach annotators. Reusable starting points are provided as guideline templates.

Guidelines & structure

GET/api/v1/guidelinesList guidelines.
POST/api/v1/guidelinesCreate a guideline.
GET/api/v1/guidelines/{id}/sectionsList sections within a guideline.
GET/api/v1/guidelines/{id}/labelsList label definitions.
GET/api/v1/guidelines/{id}/examplesList worked examples.

Revisions & validation

GET/api/v1/guidelines/{id}/revisionsList the revision history.
POST/api/v1/guidelines/{id}/validationsRun validation checks on a guideline.
GET/api/v1/guidelines/{id}/ambiguity-flagsList detected ambiguity flags.

Templates

GET/api/v1/guideline-templatesList reusable guideline templates.

See the full schema and parameters in the Label Backend API reference.