Skip to main content
GET
/
v1
/
collections
/
features
/
extractors
List Feature Extractors
curl --request GET \
  --url https://api.mixpeek.com/v1/collections/features/extractors \
  --header 'Authorization: Bearer <token>'
[
  {
    "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": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "single",
        "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>",
        "type": "keyword",
        "field_schema": {
          "type": "text",
          "tokenizer": "word",
          "min_token_len": 2,
          "max_token_len": 15,
          "lowercase": true
        },
        "is_protected": false
      }
    ],
    "source": "builtin",
    "costs": {
      "tier": 2,
      "tier_label": "<string>",
      "rates": [
        {
          "unit": "minute",
          "credits_per_unit": 2,
          "description": "<string>"
        }
      ]
    },
    "position_fields": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

Successful Response

​
feature_extractor_name
string
required
​
version
string
required
​
feature_extractor_id
string
required
​
description
string
required
​
icon
string
required
​
input_schema
Input Schema · object
required
​
output_schema
Output Schema · object
required
​
parameter_schema
Parameter Schema · object
required
​
supported_input_types
string[]
required
​
max_inputs
Max Inputs · object
required
​
default_parameters
Default Parameters · object
required
​
required_vector_indexes
VectorIndexDefinition · object[] | null
required
​
required_payload_indexes
PayloadIndexConfig · object[] | null
required
​
source
enum<string>
default:builtin

The origin/source of this extractor: 'builtin' (shipped with Mixpeek), 'custom' (user-created), or 'community' (marketplace).

Available options:
builtin,
custom,
community
​
costs
CostsInfo · object

Credit cost information for this extractor

​
position_fields
string[]

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).

Examples:
["start_time", "end_time"]
["chunk_index"]
[]