Skip to main content
GET
/
v1
/
discovery
Get All Discovery Information
curl --request GET \
  --url https://api.mixpeek.com/v1/discovery \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.mixpeek.com/v1/discovery"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mixpeek.com/v1/discovery', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/discovery",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.mixpeek.com/v1/discovery"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/discovery")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/discovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "extractors": [
    {
      "name": "<string>",
      "version": "<string>",
      "description": "<string>",
      "supported_modalities": [
        "<string>"
      ],
      "output_features": [
        {}
      ],
      "input_schema": {},
      "parameter_schema": {},
      "output_schema": {},
      "costs": {
        "tier": 2,
        "tier_label": "<string>",
        "rates": [
          {
            "credits_per_unit": 2,
            "description": "<string>"
          }
        ]
      },
      "type_mode": "<string>",
      "expected_input_types": {},
      "inference_type": "<string>",
      "supported_input_types": [
        "<string>"
      ],
      "max_inputs": {},
      "default_parameters": {},
      "required_vector_indexes": [
        {}
      ],
      "position_fields": [
        "<string>"
      ],
      "capabilities": [
        "<string>"
      ],
      "example_usage": {}
    }
  ],
  "stages": [
    {
      "stage_id": "<string>",
      "description": "<string>",
      "category": "<string>",
      "icon": "<string>",
      "parameter_schema": {},
      "example_config": {},
      "common_use_cases": [
        "<string>"
      ],
      "cost_tier": "moderate",
      "requires_collections": true
    }
  ],
  "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"
      }
    }
  }
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

Authorizations

Authorization
string
header
required

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

Response

Successful Response

Combined discovery response with all available resources.

extractors
ExtractorDiscovery · object[]

Available feature extractors

stages
StageDiscovery · object[]

Available retriever stages

manifest_schema
ManifestSchemaDiscovery · object | null

Manifest schema information

Example:
{
"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" }
}
}