Bulk Annotations
curl --request POST \
--url https://api.mixpeek.com/v1/annotations/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--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>"
]
}
'import requests
url = "https://api.mixpeek.com/v1/annotations/bulk"
payload = {
"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>"]
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>']
})
};
fetch('https://api.mixpeek.com/v1/annotations/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/annotations/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/annotations/bulk"
payload := strings.NewReader("{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/annotations/bulk")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/annotations/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_count": 0,
"updated_count": 0,
"deleted_count": 0,
"failed_count": 0,
"results": [
{
"operation": "<string>",
"success": true,
"annotation_id": "<string>",
"error": "<string>"
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Annotations
Bulk Annotations
Create, update, and/or delete annotations in a single call.
Each operation is independent — a failure in one does not roll back the others. Maximum 1000 operations per type (creates, updates, deletes).
POST
/
v1
/
annotations
/
bulk
Bulk Annotations
curl --request POST \
--url https://api.mixpeek.com/v1/annotations/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--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>"
]
}
'import requests
url = "https://api.mixpeek.com/v1/annotations/bulk"
payload = {
"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>"]
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>']
})
};
fetch('https://api.mixpeek.com/v1/annotations/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/annotations/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/annotations/bulk"
payload := strings.NewReader("{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/annotations/bulk")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/annotations/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"create\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {},\n \"retriever_id\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"stage_name\": \"<string>\"\n }\n ],\n \"update\": [\n {\n \"annotation_id\": \"<string>\",\n \"label\": \"<string>\",\n \"confidence\": 0.5,\n \"reasoning\": \"<string>\",\n \"payload\": {}\n }\n ],\n \"delete\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_count": 0,
"updated_count": 0,
"deleted_count": 0,
"failed_count": 0,
"results": [
{
"operation": "<string>",
"success": true,
"annotation_id": "<string>",
"error": "<string>"
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Authorizations
Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.
Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.
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.
Was this page helpful?
⌘I