Skip to main content
All SDKs are auto-generated from the OpenAPI spec and stay in sync with every API release.

​
Python SDK

pip install mixpeek  # Python 3.9+

from mixpeek import Mixpeek

client = Mixpeek(api_key="YOUR_API_KEY")

# Create a collection
col = client.collections.create(
    collection_name="my-collection",
    namespace_id="ns_xxx",
    source={"type": "bucket", "bucket_id": "bkt_xxx"},
    feature_extractor={"feature_extractor_name": "text_extractor", "version": "v1"}
)

# Execute a retriever
results = client.retrievers.execute(
    retriever_id="ret_xxx",
    namespace_id="ns_xxx",
    inputs={"query_text": "search query"},
    limit=10
)
Available API classes: NamespacesApi, BucketsApi, CollectionsApi, DocumentsApi, RetrieversApi, TaxonomiesApi, ClustersApi, AlertsApi, WebhooksApi, PluginsApi, AdhocRetrieversApi, AnalyticsApi. PyPI → · Python SDK reference →

​
JavaScript / TypeScript SDK

npm install mixpeek

import Mixpeek from "mixpeek";

const client = new Mixpeek({ apiKey: "YOUR_API_KEY" });

const results = await client.retrievers.execute({
    retrieverId: "ret_xxx",
    namespaceId: "ns_xxx",
    inputs: { query_text: "search query" },
    limit: 10
});
100% type-safe with Zod runtime validation. Works with Next.js, Express, and any Node.js environment. npm → · JS SDK reference →

​
CLI

The CLI is for building, testing, and deploying custom plugins: 
pip install mixpeek

mixpeek plugin init my-plugin    # Scaffold a new plugin
mixpeek plugin test my-plugin    # Validate locally
mixpeek plugin publish my-plugin # Upload and deploy
mixpeek plugin list              # List deployed plugins
See the plugins guide for the full development workflow.

​
Direct REST

Every Mixpeek capability is available via REST. Two headers required on every request: 
curl -X POST "https://api.mixpeek.com/v1/retrievers/$RETRIEVER_ID/execute" \
  -H "Authorization: Bearer $MIXPEEK_API_KEY" \
  -H "X-Namespace: $NAMESPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{ "inputs": {"query_text": "search query"}, "limit": 10 }'
Full API reference →