Update Namespace

Fully updates an existing namespace (all fields required)

PUT /v1/namespaces/{namespace_identifier}

Update Namespace

cURL

curl --request PUT \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "product-search",
  "payload_indexes": [
    {
      "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": false,
        "type": "keyword"
      },
      "is_protected": false,
      "type": "keyword"
    }
  ]
}
'

200

{
  "namespace_name": "product-search",
  "object": "namespace",
  "namespace_id": "<string>",
  "namespace_type": "standard",
  "scope": "org",
  "infrastructure": {
    "autoscaling_enabled": false,
    "compute_tier": "shared",
    "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>",
      "field_schema": {
        "type": "text",
        "tokenizer": "word",
        "min_token_len": 2,
        "max_token_len": 15,
        "lowercase": true
      },
      "is_protected": false
    }
  ],
  "payload_index_count": 123,
  "document_count": 123,
  "bucket_count": 123,
  "collection_count": 123,
  "object_count": 123,
  "auto_create_indexes": false,
  "vector_inference_map": {},
  "dynamic_vector_indexes": true,
  "mode": "<string>",
  "vector_configs": [
    {}
  ],
  "qdrant_status": {},
  "clone_status": "<string>",
  "clone_error": "<string>",
  "source_namespace_id": "<string>",
  "namespace_ready": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

Path Parameters

namespace_identifier · string · required

Either the namespace name or namespace ID

Examples:

"my_namespace"

"ns_1234567890"

Body

application/json

Request schema for updating a namespace's payload indexes.

namespace_name · string | null

Name of the namespace to update

Required string length: 3 - 64

Example:

"product-search"

payload_indexes · PayloadIndexConfig · object[] | null

Updated list of payload index configurations

Show child attributes

Example:

[
  {
    "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": false, "type": "keyword" },
    "is_protected": false,
    "type": "keyword"
  }
]

Response

200

application/json

Successful Response

Namespace model.

namespace_name · string · required

Name of the namespace

Maximum string length: 64

Example:

"product-search"

object · string · default: namespace · read-only

Resource type identifier, always 'namespace'.

namespace_id · string

Unique identifier for the namespace. Format: ns_.

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 | null

Infrastructure configuration for the namespace.

Show child attributes

Example:

{
  "autoscaling_enabled": false,
  "compute_tier": "shared",
  "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 a dedicated compute and vector 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

Show child attributes

payload_indexes · PayloadIndexConfig · object[] | null

Custom payload indexes configured for this namespace

Show child attributes

payload_index_count · integer | null

Number of USER (non-protected) payload indexes on this namespace — the same count the Studio Namespaces table shows per row. Populated even in the summary LIST view, which omits the heavy payload_indexes array itself (MS-833: the array is ~75% of the list payload, but its count is a single integer). Without it the table can only show '—'.

document_count · integer | null

Total number of documents in this namespace

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 | null

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

Show child attributes

dynamic_vector_indexes · boolean | null

Creation-time marker for BYO vector-name handling (SP-263). False = the namespace was created with EXPLICIT vector_configs, so upserting a vector name outside those configs is rejected (422) instead of silently auto-indexed under a name nothing searches. True = fully dynamic BYO namespace (created without vector_configs): new vector names keep being inferred on first upsert. Null (namespaces that predate the marker) behaves as True so existing flows are unchanged.

mode · string | null

Namespace mode: 'managed' (Mixpeek manages vector schemas and inference) or 'standalone' (bring-your-own vectors). Populated from the stored mvs_mode; null for namespaces that predate BYOV.

vector_configs · Vector Configs · object[] | null

For standalone / promoted (BYO-vector) namespaces, the per-vector configs: name, dimension, metric. Populated from the stored mvs_vector_configs; null for managed namespaces with no BYO vectors.

qdrant_status · Qdrant Status · object | null

Live vector collection status. Populated when retrieving a namespace. Includes: status (green/yellow/red), points_count, indexed_vectors_count, segments_count. None if vector collection does not exist or is unreachable.

clone_status · string | null

Deep-clone / scaffold sample-data progress: 'cloning' (in flight), 'ready' (completed), 'failed' (see clone_error). Null for namespaces that were never cloned. Poll this after a scaffold instantiate with include_sample_data=true.

clone_error · string | null

Error detail when clone_status='failed'; null otherwise.

source_namespace_id · string | null

For a cloned namespace, the source (golden/sample) namespace id it was cloned from.

namespace_ready · boolean · default: false

ALWAYS PRESENT (BACKE-3008). True only after the server CONFIRMED this namespace is usable: its vector collection exists and is reachable (a served live count, the MI-2947 readiness signal) and no clone is in flight. Never a prediction or timestamp. A wizard-created namespace mid-provision reads false (poll the namespace GET; it flips true on the first confirming read and the flip is persisted). Namespaces created before the feature shipped emit true; post-ship namespaces with no stored value emit false (fail toward not-ready).

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.