Patch Annotation

curl --request PATCH \
  --url https://api.mixpeek.com/v1/annotations/{annotation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "label": "<string>",
  "confidence": 0.5,
  "reasoning": "<string>",
  "payload": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/annotations/{annotation_id}"

payload = {
    "label": "<string>",
    "confidence": 0.5,
    "reasoning": "<string>",
    "payload": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({label: '<string>', confidence: 0.5, reasoning: '<string>', payload: {}})
};

fetch('https://api.mixpeek.com/v1/annotations/{annotation_id}', 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/{annotation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'confidence' => 0.5,
    'reasoning' => '<string>',
    'payload' => [
        
    ]
  ]),
  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/{annotation_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mixpeek.com/v1/annotations/{annotation_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/annotations/{annotation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}"

response = http.request(request)
puts response.read_body

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

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

PATCH

annotations

{annotation_id}

Patch Annotation

curl --request PATCH \
  --url https://api.mixpeek.com/v1/annotations/{annotation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "label": "<string>",
  "confidence": 0.5,
  "reasoning": "<string>",
  "payload": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/annotations/{annotation_id}"

payload = {
    "label": "<string>",
    "confidence": 0.5,
    "reasoning": "<string>",
    "payload": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({label: '<string>', confidence: 0.5, reasoning: '<string>', payload: {}})
};

fetch('https://api.mixpeek.com/v1/annotations/{annotation_id}', 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/{annotation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'confidence' => 0.5,
    'reasoning' => '<string>',
    'payload' => [
        
    ]
  ]),
  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/{annotation_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mixpeek.com/v1/annotations/{annotation_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/annotations/{annotation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"confidence\": 0.5,\n  \"reasoning\": \"<string>\",\n  \"payload\": {}\n}"

response = http.request(request)
puts response.read_body

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

{
  "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

Authorization

string

header

required

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.

X-Namespace

string

header

required

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.

Path Parameters

annotation_id

string

required

Body

application/json

Partial update to an annotation.

label

string | null

Required string length: 1 - 100

confidence

number | null

Required range: 0 <= x <= 1

reasoning

string | null

Maximum string length: 5000

payload

Payload · object | null

Response

Successful Response

Single annotation response.

document_id

string

required

The document this annotation is attached to.

namespace_id

string

required

Namespace scope.

label

string

required

Human decision label. Domain-specific — e.g. 'approved', 'rejected', 'deferred', 'infringement', 'safe', 'confirmed_dupe'.

Required string length: 1 - 100

annotation_id

string

Unique annotation identifier.

collection_id

string | null

Collection the document belongs to.

confidence

number | null

Human confidence in this decision (0.0–1.0).

Required range: 0 <= x <= 1

reasoning

string | null

Why this decision was made. Stored for audit trail.

Maximum string length: 5000

payload

Payload · object | null

Use-case-specific structured data. E.g. {'codes_approved': ['E11.40'], 'raf_impact': 0.302}

retriever_id

string | null

Retriever that produced the document being annotated.

execution_id

string | null

Retriever execution ID.

stage_name

string | null

Stage that produced the result (e.g. 'llm_enrich').

actor_id

string

default:system

Who made the annotation (user ID or API key ID).

actor_type

string

default:system

Actor type: 'user', 'api_key', or 'system'.

created_at

string<date-time>

updated_at

string<date-time>

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

Patch Annotation

Authorizations

Path Parameters

Body

Response