v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Namespace Extractors

List all extractors available to namespace

List all feature extractors available for use in this namespace.

This endpoint returns a unified view combining:

Builtin extractors: Core extractors shipped with Mixpeek (text_extractor, image_extractor, etc.)
Custom plugins: User-uploaded plugins at org or namespace level (Enterprise)

Each extractor includes:

input_schema: JSON schema for input data validation
output_schema: JSON schema for output document structure
parameter_schema: JSON schema for configurable parameters
required_vector_indexes: Vector indexes produced by this extractor
feature_uri: URI to reference this extractor in collections

Use Cases:

Discover available extractors when creating collections
Get schema information for SDK code generation
Check which custom plugins are deployed

Filtering:

source=builtin: Only builtin extractors
source=custom: Only custom plugins
source=all (default): All extractors

get/v1/namespaces/{namespace_id}/extractors

Path parameters

namespace_idstring required

Query parameters

source'builtin' | 'custom' | 'all' nullable

Filter by extractor source (builtin, custom, or all)

include_disabledboolean

Include disabled/undeployed custom plugins

Response

List of all available extractors

successboolean

Whether the request succeeded

totalinteger required

Total number of extractors

namespace_idstring required

Namespace ID

builtin_countinteger required

Number of builtin extractors

custom_countinteger required

Number of custom extractors (org + namespace level)

Example response

{
  "extractors": [
    {
      "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"
        }
      ]
    }
  ]
}