List Annotations

curl --request POST \
  --url https://api.mixpeek.com/v1/annotations/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "document_id": "<string>",
  "collection_id": "<string>",
  "label": "<string>",
  "actor_id": "<string>",
  "retriever_id": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/annotations/list"

payload = {
    "document_id": "<string>",
    "collection_id": "<string>",
    "label": "<string>",
    "actor_id": "<string>",
    "retriever_id": "<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({
    document_id: '<string>',
    collection_id: '<string>',
    label: '<string>',
    actor_id: '<string>',
    retriever_id: '<string>'
  })
};

fetch('https://api.mixpeek.com/v1/annotations/list', 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/list",
  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([
    'document_id' => '<string>',
    'collection_id' => '<string>',
    'label' => '<string>',
    'actor_id' => '<string>',
    'retriever_id' => '<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/list"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\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/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/annotations/list")

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  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\n}"

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

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

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

POST

annotations

list

List Annotations

curl --request POST \
  --url https://api.mixpeek.com/v1/annotations/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "document_id": "<string>",
  "collection_id": "<string>",
  "label": "<string>",
  "actor_id": "<string>",
  "retriever_id": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/annotations/list"

payload = {
    "document_id": "<string>",
    "collection_id": "<string>",
    "label": "<string>",
    "actor_id": "<string>",
    "retriever_id": "<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({
    document_id: '<string>',
    collection_id: '<string>',
    label: '<string>',
    actor_id: '<string>',
    retriever_id: '<string>'
  })
};

fetch('https://api.mixpeek.com/v1/annotations/list', 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/list",
  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([
    'document_id' => '<string>',
    'collection_id' => '<string>',
    'label' => '<string>',
    'actor_id' => '<string>',
    'retriever_id' => '<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/list"

	payload := strings.NewReader("{\n  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\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/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/annotations/list")

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  \"document_id\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"actor_id\": \"<string>\",\n  \"retriever_id\": \"<string>\"\n}"

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

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

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

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[]

Show child attributes

total_count

integer

default:0

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

List Annotations

Authorizations

Query Parameters

Body

Response