v5

OpenAPI 3.1.02026-08-025631,1012.8 MB

Annotations

List Annotations

Query annotations with optional filters.

post/v1/annotations/list

Query parameters

skipinteger

limitinteger

Request body

document_idstring nullable

Filter by document.

collection_idstring nullable

Filter by collection.

labelstring nullable

Filter by label.

actor_idstring nullable

Filter by who annotated.

retriever_idstring nullable

Filter by retriever.

Response

Successful Response

total_countinteger

Example response

{
  "results": [
    {
      "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"
    }
  ]
}