Sign in
Annotations

Get Annotation

Get a single annotation by ID.

get/v1/annotations/{annotation_id}

Path parameters

annotation_idstring required

Response

Successful Response

annotation_idstring

Unique annotation identifier.

document_idstring required

The document this annotation is attached to.

collection_idstring nullable

Collection the document belongs to.

namespace_idstring required

Namespace scope.

labelstring required

Human decision label. Domain-specific — e.g. 'approved', 'rejected', 'deferred', 'infringement', 'safe', 'confirmed_dupe'.

confidencenumber nullable

Human confidence in this decision (0.0–1.0).

reasoningstring nullable

Why this decision was made. Stored for audit trail.

payloadobject nullable

Use-case-specific structured data. E.g. {'codes_approved': ['E11.40'], 'raf_impact': 0.302}

retriever_idstring nullable

Retriever that produced the document being annotated.

execution_idstring nullable

Retriever execution ID.

stage_namestring nullable

Stage that produced the result (e.g. 'llm_enrich').

actor_idstring

Who made the annotation (user ID or API key ID).

actor_typestring

Actor type: 'user', 'api_key', or 'system'.

created_atstring date-time
updated_atstring date-time
versioninteger

Current version; starts at 1, bumps per edit.

Example response

{
  "actor_id": "user_eric",
  "actor_type": "user",
  "annotation_id": "ann_abc123def4567890",
  "collection_id": "col_notes",
  "confidence": 0.95,
  "document_id": "doc_xyz",
  "label": "approved",
  "namespace_id": "ns_vitae",
  "payload": {
    "codes_approved": [
      "E11.40",
      "E11.65"
    ],
    "raf_impact": 0.42
  },
  "reasoning": "Note clearly documents peripheral neuropathy.",
  "retriever_id": "ret_hcc_review"
}

Changes

Changed in 2 of the 28 revisions of this API.3

  • 27f74c951c4d2See the full diff
    • ○

      added the optional property revisions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property version to the response with the 200 status

      response-optional-property-added

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog