v5

OpenAPI 3.1.02026-08-025631,1012.8 MB
Discovery

Get All Discovery Information

Returns combined discovery information including extractors, stages, and manifest schema in a single request. Use this for comprehensive capability discovery.

get/v1/discovery

Response

Successful Response

Example response

{
  "extractors": [
    {
      "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"
    }
  ],
  "stages": [
    {
      "category": "filter",
      "common_use_cases": [
        "Semantic search over embeddings",
        "Multi-modal retrieval",
        "Hybrid search with fusion"
      ],
      "cost_tier": "moderate",
      "description": "Unified multi-vector search with N feature URIs and fusion",
      "example_config": {
        "parameters": {
          "feature_uri": "multimodal_extractor.v1.embedding",
          "query": "{{ INPUT.query }}",
          "top_k": 25
        },
        "stage_id": "feature_filter",
        "stage_name": "semantic_search"
      },
      "icon": "search",
      "parameter_schema": {
        "properties": {
          "feature_uri": {
            "type": "string"
          },
          "top_k": {
            "default": 25,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "requires_collections": true,
      "stage_id": "feature_filter"
    }
  ],
  "manifest_schema": {
    "dependency_graph": {
      "bucket": [
        "namespace"
      ],
      "collection": [
        "namespace",
        "bucket"
      ],
      "retriever": [
        "namespace",
        "collection"
      ]
    },
    "examples": {
      "namespace": "namespaces:\n  - name: my_ns\n    feature_extractors:\n      - name: multimodal_extractor"
    },
    "manifest_version": "1.0",
    "resource_types": [
      "namespace",
      "bucket",
      "collection",
      "retriever"
    ],
    "schemas": {
      "namespace": {
        "properties": {},
        "type": "object"
      }
    }
  }
}