v5

OpenAPI 3.1.02026-08-025631,1012.8 MB

Extractors

List all extractors available to organization

List all extractors available across the organization.

Returns a unified view combining:

Builtin extractors: Core extractors shipped with Mixpeek
Custom extractors: Org-level custom extractors (uploaded via the upload workflow)

Use source to filter by origin.

get/v1/extractors

Query parameters

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

Filter by extractor source

include_disabledboolean

Include disabled/undeployed custom extractors

Response

Successful Response

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"
        }
      ]
    }
  ]
}