Create Namespace
Creates a new namespace with specified feature extractors and payload indexes.
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.
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer YOUR_API_KEY"
"Bearer YOUR_STRIPE_API_KEY"
Body
Request schema for creating a new namespace.
Name of the namespace to create
3 - 64"product-search"
REQUIRED. List of feature extractors to configure for this namespace. At least one feature extractor must be provided. Each extractor requires 'feature_extractor_name' and 'version'. Optional 'params' can be specified for extractors with configurable settings (e.g., model selection) that affect vector dimensions. These params are locked at namespace creation time. Example: [{"feature_extractor_name": "multimodal_extractor", "version": "v1"}]
1[
{
"feature_extractor_id": "multimodal_extractor_v1",
"feature_extractor_name": "multimodal_extractor",
"version": "v1"
},
{
"feature_extractor_id": "image_extractor_v1",
"feature_extractor_name": "image_extractor",
"params": { "model": "siglip_base" },
"version": "v1"
}
]
Optional namespace ID override. Used for recovery/migration when recreating a namespace with a known ID. If not provided, a new ID is auto-generated.
Type of namespace. STANDARD for regular namespaces, MARKETPLACE for curated datasets.
standard, marketplace Ownership scope. ORG (default) creates an org-scoped namespace. SYSTEM requires Mixpeek admin privileges and creates a namespace visible read-only to every org — used for curated sample corpora.
org, system Description of the namespace
"This namespace contains playlists from Spotify"
Optional list of custom payload index configurations. Indexes required by selected feature extractors will be added automatically.
[
{
"field_name": "metadata.title",
"field_schema": {
"lowercase": true,
"max_token_len": 15,
"min_token_len": 2,
"tokenizer": "word",
"type": "text"
},
"is_protected": false,
"type": "text"
},
{
"field_name": "metadata.description",
"field_schema": { "is_tenant": true, "type": "keyword" },
"is_protected": false,
"type": "keyword"
}
]
Enable automatic creation of Qdrant payload indexes based on filter usage patterns. When enabled, the system tracks which fields are most frequently filtered (>100 queries/24h) and automatically creates indexes to improve query performance. Background task runs every 6 hours. Expected performance improvement: 50-90% latency reduction for filtered queries.
true
Time-to-live in seconds. Namespace will be auto-deleted after this duration.
x >= 60Optional dedicated infrastructure configuration for this namespace. Required for custom plugins and custom models (Enterprise tier). If None, uses shared infrastructure or organization-level infrastructure.
{
"autoscaling_enabled": false,
"compute_tier": "shared",
"description": "Shared development namespace",
"max_concurrent_jobs": 10,
"qdrant_collection": "ns_dev",
"ray_head_node_url": "ray://shared-cluster:10001"
}
Response
Successful Response
Namespace model.
Name of the namespace
64"product-search"
Unique identifier for the namespace
Type of namespace. STANDARD for regular namespaces, MARKETPLACE for curated datasets that can be subscribed to.
standard, marketplace Ownership scope. ORG (default) is org-scoped — only visible to members of the owning organization. SYSTEM is Mixpeek-owned and visible read-only to every authenticated org; used for curated sample corpora. Mutations on SYSTEM namespaces require admin auth.
org, system Infrastructure configuration for the namespace (Ray, Qdrant).
{
"autoscaling_enabled": false,
"compute_tier": "shared",
"description": "Shared development namespace",
"max_concurrent_jobs": 10,
"qdrant_collection": "ns_dev",
"ray_head_node_url": "ray://shared-cluster:10001"
}
Infrastructure cluster ID for this namespace (Enterprise only). When set, this namespace uses dedicated Anyscale/Ray + Qdrant cluster. If None, uses shared infrastructure or organization-level infrastructure. Format: iclstr_xxx
"iclstr_abc123xyz"
Description of the namespace
List of feature extractors configured for this namespace
Custom payload indexes configured for this namespace
Total number of documents in this namespace (from Qdrant collection)
Total number of buckets in this namespace
Total number of collections in this namespace
Total number of objects across all buckets in this namespace
Enable automatic creation of Qdrant payload indexes based on filter usage patterns. When enabled, the system tracks which fields are most frequently filtered (>100 queries/24h) and automatically creates indexes to improve query performance. Background task runs every 6 hours. Expected performance improvement: 50-90% latency reduction for filtered queries.
Mapping of vector index names to inference service names. Built at namespace creation based on extractor configurations. Used by feature search to determine correct inference service for queries. Example: {'image_extractor_v1_embedding': 'google_siglip_base_v1'}
Live Qdrant collection status. Populated when retrieving a namespace. Includes: status (green/yellow/red), points_count, indexed_vectors_count, segments_count. None if Qdrant collection does not exist or is unreachable.
When the namespace was created
When the namespace was last updated
UTC timestamp after which the namespace is auto-deleted by the hourly cleanup_expired_namespaces reaper. Computed at create time from CreateNamespaceRequest.ttl_seconds; null means the namespace never expires.