List Available Feature Extractors

Discover all available feature extractors with their capabilities, supported modalities, output features, and example usage. Use this to understand what extractors are available when configuring namespaces and collections in manifests.

GET /v1/discovery/extractors

List Available Feature Extractors

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/discovery/extractors \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "costs": {
      "rates": [
        {
          "credits_per_unit": 10,
          "description": "Per minute of video processed",
          "unit": "minute"
        }
      ],
      "tier": 2,
      "tier_label": "STANDARD"
    },
    "description": "Extracts embeddings from text, images, and video frames",
    "example_usage": {
      "collection": {
        "feature_extractor": {
          "input_mappings": {
            "content": "video"
          },
          "name": "multimodal_extractor",
          "parameters": {
            "split_method": "time",
            "time_split_interval": 10
          },
          "version": "v1"
        }
      },
      "namespace": {
        "feature_extractors": [
          {
            "name": "multimodal_extractor",
            "version": "v1"
          }
        ]
      }
    },
    "name": "multimodal_extractor",
    "output_features": [
      {
        "name": "multimodal_embedding",
        "type": "embedding",
        "uri": "mixpeek://multimodal_extractor@v1/multimodal_embedding"
      }
    ],
    "parameter_schema": {
      "properties": {
        "split_method": {
          "default": "time",
          "description": "Video splitting strategy",
          "type": "string"
        },
        "time_split_interval": {
          "default": 10,
          "description": "Interval in seconds for time splitting",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "supported_input_types": [
      "video",
      "image"
    ],
    "supported_modalities": [
      "video",
      "image"
    ],
    "version": "v1"
  }
]

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Successful Response

name · string · required

Feature extractor name (e.g., 'multimodal_extractor')

version · string · required

Feature extractor version (e.g., 'v1')

description · string · required

Human-readable description of what this extractor does

supported_modalities · string[]

List of supported input modalities (text, image, video, audio)

output_features · Output Features · object[]

List of features produced by this extractor

input_schema · Input Schema · object | null

JSON Schema for extractor inputs — what fields the extractor reads from source objects

parameter_schema · Parameter Schema · object | null

JSON Schema for tunable parameters (defaults, ranges, descriptions for every knob)

output_schema · Output Schema · object | null

JSON Schema for output documents — what fields appear in extracted documents

costs · CostsInfo · object | null

Credit cost information (tier, per-unit rates)

Show child attributes

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 | null

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

Show child attributes

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

Accepted input types (e.g., ['video', 'image'])

max_inputs · Max Inputs · object

Maximum number of inputs per type (e.g., {'video': 1})

Show child attributes

default_parameters · Default Parameters · object

Default parameter values — use as a starting point for tuning

required_vector_indexes · Required Vector Indexes · object[] | null

Vector indexes produced by this extractor (name, dimensions, distance metric, feature_uri)

position_fields · string[]

Fields that uniquely identify each output document within a source object

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

realtime_available · boolean | null

Whether every Ray Serve application this extractor needs for real-time inference is running on the deployment serving this request. True when all of them report RUNNING. False when one is absent or not running; see serve_apps for which. Null when the extractor needs none, or when the live list could not be read.

serve_apps · ServeAppStatus · object[]

The Ray Serve applications this extractor needs for real-time inference, each with its live status. Empty when it needs none.

Show child attributes