Skip to main content
POST
/
v1
/
annotations
/
list
List Annotations
curl --request POST \
  --url https://api.mixpeek.com/v1/annotations/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_id": "<string>",
  "collection_id": "<string>",
  "label": "<string>",
  "actor_id": "<string>",
  "retriever_id": "<string>"
}
'
{
  "results": [
    {
      "document_id": "<string>",
      "namespace_id": "<string>",
      "label": "<string>",
      "annotation_id": "<string>",
      "collection_id": "<string>",
      "confidence": 0.5,
      "reasoning": "<string>",
      "payload": {},
      "retriever_id": "<string>",
      "execution_id": "<string>",
      "stage_name": "<string>",
      "actor_id": "system",
      "actor_type": "system",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Query Parameters

​
skip
integer
default:0
Required range: x >= 0
​
limit
integer
default:50
Required range: 1 <= x <= 500

Body

application/json

Query parameters for listing annotations.

​
document_id
string | null

Filter by document.

​
collection_id
string | null

Filter by collection.

​
label
string | null

Filter by label.

​
actor_id
string | null

Filter by who annotated.

​
retriever_id
string | null

Filter by retriever.

Response

Successful Response

Paginated annotation list.

​
results
AnnotationResponse · object[]
​
total_count
integer
default:0