curl --request GET \
--url https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_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{
"feature_extractor_name": "<string>",
"version": "<string>",
"feature_extractor_id": "<string>",
"description": "<string>",
"icon": "<string>",
"input_schema": {},
"output_schema": {},
"parameter_schema": {},
"supported_input_types": [
"<string>"
],
"max_inputs": {},
"default_parameters": {},
"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"
}
],
"category": "general",
"source": "builtin",
"type_mode": "<string>",
"expected_input_types": {},
"inference_type": "<string>",
"costs": {
"tier": 2,
"tier_label": "<string>",
"rates": [
{
"unit": "minute",
"credits_per_unit": 2,
"description": "<string>"
}
]
},
"position_fields": [
"start_time",
"end_time"
],
"capabilities": [
"<string>"
],
"example_usage": {}
}{
"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
}Get Feature Extractor by Name
Get detailed information about a specific feature extractor by its name
curl --request GET \
--url https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_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/collections/features/extractors/{feature_extractor_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/features/extractors/{feature_extractor_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{
"feature_extractor_name": "<string>",
"version": "<string>",
"feature_extractor_id": "<string>",
"description": "<string>",
"icon": "<string>",
"input_schema": {},
"output_schema": {},
"parameter_schema": {},
"supported_input_types": [
"<string>"
],
"max_inputs": {},
"default_parameters": {},
"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"
}
],
"category": "general",
"source": "builtin",
"type_mode": "<string>",
"expected_input_types": {},
"inference_type": "<string>",
"costs": {
"tier": 2,
"tier_label": "<string>",
"rates": [
{
"unit": "minute",
"credits_per_unit": 2,
"description": "<string>"
}
]
},
"position_fields": [
"start_time",
"end_time"
],
"capabilities": [
"<string>"
],
"example_usage": {}
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
Feature extractor response model for API responses.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Category of this extractor, used for UI grouping and filtering. Examples: 'text', 'image', 'multimodal', 'audio', 'video', 'document', 'face', 'corpus', 'utility', 'safety', 'classification', 'web', 'custom'.
The origin/source of this extractor: 'builtin' (shipped with Mixpeek), 'custom' (user-created), or 'community' (marketplace).
builtin, custom, community What input types this extractor can handle: 'type_specific' (only one type) or 'multimodal' (handles multiple types). Type-specific extractors cannot use automatic-typed bucket properties.
For type-specific extractors: maps input keys to required types (e.g., {'video': 'video'}). For multimodal extractors: null.
Show child attributes
Show child attributes
Kind of real-time inference this extractor provides: 'embedding', 'rerank', 'classify', 'generate', or 'general'. Null if batch-only.
Credit cost information for this extractor
Show child attributes
Show child attributes
Output fields that uniquely identify each document within a source object. Enables idempotent reprocessing: rerunning a batch produces the same document IDs, so existing documents are updated instead of creating duplicates. Works with bucket unique_key to enable fully deterministic document IDs. Empty list means single-output extractor (one document per source). Read-only (set by extractor).
["start_time", "end_time"]
["chunk_index"]
[]
What this extractor can do: 'batch' (feature extraction during ingestion), 'realtime' (query-time inference for retriever stages)
Minimal working configuration for namespace + collection + input_mappings + parameters
Was this page helpful?

