Skip to main content
GET
/
v1
/
namespaces
/
{namespace_id}
/
extractors
/
{extractor_id}
Get extractor details
curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_id}/extractors/{extractor_id}
{
  "feature_extractor_name": "<string>",
  "version": "<string>",
  "feature_extractor_id": "<string>",
  "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": [
      {
        "credits_per_unit": 2,
        "description": "<string>"
      }
    ]
  },
  "required_vector_indexes": [
    {
      "name": "<string>",
      "description": "<string>",
      "index": {
        "datatype": "float32",
        "description": "Dense vector embedding for text content using E5-Large multilingual model. Optimized for semantic search across 100+ languages.",
        "dimensions": 1024,
        "distance": "cosine",
        "inference_name": "multilingual_e5_large_instruct_v1",
        "name": "text_extractor_v1_embedding",
        "supported_inputs": [
          "text",
          "string"
        ],
        "type": "dense"
      },
      "feature_uri": "mixpeek://text_extractor@v1/multilingual_e5_large_instruct_v1"
    }
  ],
  "required_payload_indexes": [
    {
      "field_name": "<string>",
      "field_schema": {
        "type": "text",
        "tokenizer": "word",
        "min_token_len": 2,
        "max_token_len": 15,
        "lowercase": true
      },
      "is_protected": false
    }
  ],
  "position_fields": [
    "<string>"
  ],
  "feature_uri": "<string>",
  "capabilities": [
    "<string>"
  ],
  "example_usage": {},
  "plugin_id": "<string>",
  "deployed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
namespace_id
string
required
​
extractor_id
string
required

Response

Extractor details

Unified extractor response combining builtin and custom plugins.

This model provides a consistent view of all extractors available to a namespace, regardless of whether they are builtin or custom.

​
feature_extractor_name
string
required

Name of the feature extractor

​
version
string
required

Version of the feature extractor

​
feature_extractor_id
string
required

Unique identifier (name_version)

​
source
enum<string>
required

Origin of this extractor: 'builtin' (shipped with Mixpeek), 'custom' (user-uploaded plugin), or 'community' (marketplace)

Available options:
builtin,
custom,
community
​
description
string
required

Human-readable description

​
input_schema
Input Schema · object
required

JSON schema for input data

​
output_schema
Output Schema · object
required

JSON schema for output data

​
icon
string
default:box

Lucide-react icon name for frontend rendering

​
parameter_schema
Parameter Schema · object

JSON schema for parameters

​
type_mode
string | null

What input types this extractor can handle: 'type_specific' (only one type, e.g. video-only) or 'multimodal' (handles multiple types with conditional processing). Type-specific extractors cannot use automatic-typed bucket properties.

​
expected_input_types
Expected Input Types · object

For type-specific extractors: maps input keys to required types (e.g., {'video': 'video', 'thumbnail': 'image'}). For multimodal extractors: null.

​
inference_type
string | null

Kind of real-time inference this extractor provides: 'embedding', 'rerank', 'classify', 'generate', or 'general'. Determines which retriever stages are compatible. Null if the extractor is batch-only.

​
supported_input_types
string[]

Supported input types (video, image, text, etc.)

​
max_inputs
Max Inputs · object

Maximum number of inputs per type

​
default_parameters
Default Parameters · object

Default parameter values

​
costs
CostsInfo · object

Credit cost information (builtin extractors only)

​
required_vector_indexes
VectorIndexDefinition · object[] | null

Vector indexes this extractor produces

​
required_payload_indexes
PayloadIndexConfig · object[] | null

Payload indexes required by this extractor

​
position_fields
string[]

Fields that identify unique positions within output documents. Used for deterministic document ID generation.

​
feature_uri
string | null

Primary feature URI (e.g., mixpeek://text_extractor@v1/embedding)

​
capabilities
string[]

What this extractor can do: 'batch' (feature extraction during ingestion), 'realtime' (query-time inference for retriever stages)

​
example_usage
Example Usage · object

Minimal working configuration for namespace + collection + input_mappings + parameters

​
plugin_id
string | null

Plugin ID (custom plugins only)

​
deployed
boolean | null

Whether the plugin is deployed (custom plugins only)

​
validation_status
enum<string> | null

Validation status (custom plugins only)

Available options:
passed,
failed,
pending
​
created_at
string<date-time> | null

Creation timestamp (custom plugins only)

​
updated_at
string<date-time> | null

Last update timestamp (custom plugins only)