Skip to main content
POST
/
v1
/
annotations
/
bulk
Bulk Annotations
curl --request POST \
  --url https://api.mixpeek.com/v1/annotations/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "create": [
    {
      "document_id": "<string>",
      "label": "<string>",
      "collection_id": "<string>",
      "confidence": 0.5,
      "reasoning": "<string>",
      "payload": {},
      "retriever_id": "<string>",
      "execution_id": "<string>",
      "stage_name": "<string>"
    }
  ],
  "update": [
    {
      "annotation_id": "<string>",
      "label": "<string>",
      "confidence": 0.5,
      "reasoning": "<string>",
      "payload": {}
    }
  ],
  "delete": [
    "<string>"
  ]
}
'
{
  "created_count": 0,
  "updated_count": 0,
  "deleted_count": 0,
  "failed_count": 0,
  "results": [
    {
      "operation": "<string>",
      "success": true,
      "annotation_id": "<string>",
      "error": "<string>"
    }
  ]
}

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

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

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_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"

Body

application/json

Bulk create, update, and/or delete annotations in a single call.

Provide any combination of creates, updates, and deletes. Each operation is independent — a failure in one does not roll back the others.

​
create
BulkAnnotationCreate · object[]

Annotations to create.

Maximum array length: 1000
​
update
BulkAnnotationUpdate · object[]

Annotations to update.

Maximum array length: 1000
​
delete
string[]

Annotation IDs to delete.

Maximum array length: 1000

Response

Successful Response

Response for bulk annotation operations.

​
created_count
integer
default:0
​
updated_count
integer
default:0
​
deleted_count
integer
default:0
​
failed_count
integer
default:0
​
results
BulkAnnotationResult · object[]