Annotations

List Annotations

Changed on

Query annotations with optional filters.

post/v1/annotations/list

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/annotations/list
  • Auth: HTTP bearer and API key in header X-Namespace

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.

as_ofstring date-time nullable

Return the judgment set AS IT STOOD at this instant — annotations created later are excluded, and each remaining annotation is reconstructed to its state at that time from its revision chain. This is the reproducible-evaluation handle: an evaluation pins its as_of and re-reads the identical set later.

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"
    }
  ]
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8ef32f2ad1a6Revision changes
    • info

      added the optional property // to the response with the status