Skip to main content
PATCH
/
v1
/
namespaces
/
{namespace_identifier}
Partially Update Namespace
curl --request PATCH \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier} \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "product-search",
  "description": "<string>",
  "feature_extractors": [
    {
      "feature_extractor_name": "<string>",
      "version": "<string>",
      "params": {}
    }
  ],
  "payload_indexes": [
    {
      "field_name": "<string>",
      "type": "keyword",
      "field_schema": {
        "type": "text",
        "tokenizer": "word",
        "min_token_len": 2,
        "max_token_len": 15,
        "lowercase": true
      },
      "is_protected": false
    }
  ],
  "auto_create_indexes": true,
  "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"
  }
}
'
{
  "namespace_name": "product-search",
  "namespace_id": "<string>",
  "namespace_type": "standard",
  "scope": "org",
  "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"
  },
  "cluster_id": "iclstr_abc123xyz",
  "description": "<string>",
  "feature_extractors": [
    {
      "feature_extractor_name": "<string>",
      "version": "<string>",
      "feature_extractor_id": "<string>",
      "params": {}
    }
  ],
  "payload_indexes": [
    {
      "field_name": "<string>",
      "type": "keyword",
      "field_schema": {
        "type": "text",
        "tokenizer": "word",
        "min_token_len": 2,
        "max_token_len": 15,
        "lowercase": true
      },
      "is_protected": false
    }
  ],
  "document_count": 123,
  "bucket_count": 123,
  "collection_count": 123,
  "object_count": 123,
  "auto_create_indexes": false,
  "vector_inference_map": {},
  "qdrant_status": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

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

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Path Parameters

​
namespace_identifier
string
required

Either the namespace name or namespace ID

Examples:

"my_namespace"

"ns_1234567890"

Body

application/json

Request schema for partially updating a namespace (PATCH operation).

​
namespace_name
string | null

Updated name for the namespace

Required string length: 3 - 64
Example:

"product-search"

​
description
string | null

Updated description for the namespace

​
feature_extractors
BaseFeatureExtractorModel · object[] | null

Feature extractors to add to this namespace. Existing extractors are preserved; only new ones are appended. Each extractor must be a registered builtin plugin.

​
payload_indexes
PayloadIndexConfig · object[] | null

Updated list of custom payload indexes for this namespace.

​
auto_create_indexes
boolean | null

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. Default: False.

Example:

true

​
infrastructure
NamespaceInfrastructure · object

Infrastructure configuration for this namespace. Set compute_tier to 'dedicated_cpu' or 'dedicated_gpu' and max_custom_models > 0 to enable custom model uploads. Requires Enterprise account.

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

​
namespace_name
string
required

Name of the namespace

Maximum string length: 64
Example:

"product-search"

​
namespace_id
string

Unique identifier for the namespace

​
namespace_type
enum<string>
default:standard

Type of namespace. STANDARD for regular namespaces, MARKETPLACE for curated datasets that can be subscribed to.

Available options:
standard,
marketplace
​
scope
enum<string>
default:org

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.

Available options:
org,
system
​
infrastructure
NamespaceInfrastructure · object

Infrastructure configuration for the namespace (Ray, Qdrant).

Example:
{
  "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"
}
​
cluster_id
string | null

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

Example:

"iclstr_abc123xyz"

​
description
string | null

Description of the namespace

​
feature_extractors
BaseFeatureExtractorModel · object[]

List of feature extractors configured for this namespace

​
payload_indexes
PayloadIndexConfig · object[] | null

Custom payload indexes configured for this namespace

​
document_count
integer | null

Total number of documents in this namespace (from Qdrant collection)

​
bucket_count
integer | null

Total number of buckets in this namespace

​
collection_count
integer | null

Total number of collections in this namespace

​
object_count
integer | null

Total number of objects across all buckets in this namespace

​
auto_create_indexes
boolean
default:false

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.

​
vector_inference_map
Vector Inference Map · object

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'}

​
qdrant_status
Qdrant Status · object

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.

​
created_at
string<date-time> | null

When the namespace was created

​
updated_at
string<date-time> | null

When the namespace was last updated

​
expires_at
string<date-time> | null

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.