Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

A namespace is the isolation boundary for your vectors, documents, and indexes.

​
Create a Namespace

import requests

headers = {"Authorization": "Bearer sk_live_...", "Content-Type": "application/json"}

requests.post("https://api.mixpeek.com/v1/namespaces/standalone", headers=headers, json={
    "namespace_id": "product-search",
    "mode": "standalone",
    "vector_configs": [
        {"name": "text_embedding", "dimension": 1536, "metric": "cosine"},
        {"name": "image_embedding", "dimension": 512, "metric": "dot"}
    ]
})

​
Parameters

​
namespace_id
string
required
Unique identifier. Lowercase with hyphens (e.g., product-search).
​
mode
string
required
Must be "standalone".
​
vector_configs
array
required
Named vector indexes. Each document references these names when providing vectors.
FieldTypeDescription
namestringIndex name (e.g., text_embedding)
dimensionintegerMust match your model’s output dimension
metricstringcosine (default), dot, or euclidean
Documents can include vectors for any subset of indexes — not every index needs a vector in every document.

​
Text Indexes (BM25)

Add full-text keyword search on payload fields. Existing documents are backfilled automatically. 
curl -X POST "https://api.mixpeek.com/v1/namespaces/product-search/text-indexes" \
  -H "Authorization: Bearer $MIXPEEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"field": "title", "options": {"language": "en"}}'

​
Payload Indexes

Speed up filtered searches by indexing frequently queried payload fields. 
curl -X POST "https://api.mixpeek.com/v1/namespaces/product-search/payload-indexes" \
  -H "Authorization: Bearer $MIXPEEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"field": "category", "type": "keyword"}'
Types: keyword, integer, float, bool, datetime, geo.

​
Other Operations

OperationMethodEndpoint
Get infoGET/v1/namespaces/{id}
DeleteDELETE/v1/namespaces/{id}
ClonePOST/v1/namespaces/{id}/clone
Usage metricsGET/v1/namespaces/{id}/usage
Vector metadataPUT/v1/namespaces/{id}/vector-metadata