List all extractors available to organization
curl --request GET \
--url https://api.mixpeek.com/v1/extractors \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mixpeek.com/v1/extractors"
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/extractors', 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/extractors",
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/extractors"
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/extractors")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/extractors")
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{
"extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"feature_extractor_id": "<string>",
"source": "builtin",
"description": "<string>",
"input_schema": {},
"output_schema": {},
"icon": "box",
"parameter_schema": {},
"type_mode": "<string>",
"expected_input_types": {},
"inference_type": "<string>",
"supported_input_types": [
"<string>"
],
"max_inputs": {},
"default_parameters": {},
"costs": {
"tier": 2,
"tier_label": "<string>",
"rates": [
{
"unit": "minute",
"credits_per_unit": 2,
"description": "<string>"
}
]
},
"required_vector_indexes": [
{
"description": "Vector index for text embeddings using E5-Large model.",
"index": {
"datatype": "float32",
"description": "Dense vector embedding for text content",
"dimensions": 1024,
"distance": "cosine",
"inference_name": "multilingual_e5_large_instruct_v1",
"name": "text_extractor_v1_embedding",
"supported_inputs": [
"text",
"string"
],
"type": "dense"
},
"name": "embedding",
"type": "single"
}
],
"required_payload_indexes": [
{
"description": "User-created text index for full-text search",
"field_name": "metadata.description",
"is_protected": false,
"type": "text"
}
],
"position_fields": [
"<string>"
],
"feature_uri": "<string>",
"capabilities": [
"<string>"
],
"example_usage": {},
"plugin_id": "<string>",
"deployed": true,
"validation_status": "passed",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"namespace_id": "<string>",
"builtin_count": 123,
"custom_count": 123,
"success": true
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Submissions
List all extractors available to organization
List all extractors available across the organization.
Returns a unified view combining:
- Builtin extractors: Core extractors shipped with Mixpeek
- Custom extractors: Org-level custom extractors (uploaded via the upload workflow)
Use source to filter by origin.
GET
/
v1
/
extractors
List all extractors available to organization
curl --request GET \
--url https://api.mixpeek.com/v1/extractors \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mixpeek.com/v1/extractors"
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/extractors', 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/extractors",
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/extractors"
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/extractors")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/extractors")
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{
"extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"feature_extractor_id": "<string>",
"source": "builtin",
"description": "<string>",
"input_schema": {},
"output_schema": {},
"icon": "box",
"parameter_schema": {},
"type_mode": "<string>",
"expected_input_types": {},
"inference_type": "<string>",
"supported_input_types": [
"<string>"
],
"max_inputs": {},
"default_parameters": {},
"costs": {
"tier": 2,
"tier_label": "<string>",
"rates": [
{
"unit": "minute",
"credits_per_unit": 2,
"description": "<string>"
}
]
},
"required_vector_indexes": [
{
"description": "Vector index for text embeddings using E5-Large model.",
"index": {
"datatype": "float32",
"description": "Dense vector embedding for text content",
"dimensions": 1024,
"distance": "cosine",
"inference_name": "multilingual_e5_large_instruct_v1",
"name": "text_extractor_v1_embedding",
"supported_inputs": [
"text",
"string"
],
"type": "dense"
},
"name": "embedding",
"type": "single"
}
],
"required_payload_indexes": [
{
"description": "User-created text index for full-text search",
"field_name": "metadata.description",
"is_protected": false,
"type": "text"
}
],
"position_fields": [
"<string>"
],
"feature_uri": "<string>",
"capabilities": [
"<string>"
],
"example_usage": {},
"plugin_id": "<string>",
"deployed": true,
"validation_status": "passed",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"namespace_id": "<string>",
"builtin_count": 123,
"custom_count": 123,
"success": true
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"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.
Query Parameters
Filter by extractor source
Available options:
builtin, custom, all Include disabled/undeployed custom extractors
Response
Successful Response
Response for listing all extractors available to a namespace.
List of all available extractors
Show child attributes
Show child attributes
Total number of extractors
Namespace ID
Number of builtin extractors
Number of custom extractors (org + namespace level)
Whether the request succeeded
Was this page helpful?

