Skip to main content
GET
/
v1
/
annotations
/
{annotation_id}
Get Annotation
curl --request GET \
  --url https://api.mixpeek.com/v1/annotations/{annotation_id} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/annotations/{annotation_id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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>"
}
]
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

annotation_id
string
required

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>