Annotate example

Add or update an example's ground truth or reasoning. At least one annotation field is required. The first annotation must include groundTruth.

PATCH/v1/models/{modelId}/examples/{exampleId}/annotation

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

modelIdUUIDrequired

Model repository ID. Repository write access is required.

exampleIdUUIDrequired

Example ID.

groundTruthRecord<string, JSON value>

Expected answers keyed by question ID. noul questions use booleans, choice questions use option keys, and score questions use zero-based numeric indexes into the question's criteria array.

groundReasoningstring

Optional explanation for the ground truth.

The first annotation assigns a stable train or test split. Updating the annotation later preserves the existing split.

Returns 404 example_not_found when the example does not exist in the model, and 422 ground_truth_required when the first annotation omits groundTruth.

Response

idUUIDrequired

stateany JSON valuerequired

sourceingest | liverequired

imageUrlsstring[]required

annotationAnnotationrequired

The merged ground truth and reasoning with the preserved split.

latestDecisionDecision | nullrequired

decisionCountintegerrequired

createdAtISO 8601 datetimerequired

updatedAtISO 8601 datetimerequired

Was this page helpful?