Partially Update Namespace

curl --request PATCH \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "spotify_playlists_prod",
  "description": "<string>",
  "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
}
'

{
  "namespace_name": "spotify_playlists_dev",
  "namespace_id": "<string>",
  "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"
  },
  "description": "<string>",
  "feature_extractors": [
    {
      "feature_extractor_name": "<string>",
      "version": "<string>",
      "feature_extractor_id": "<string>"
    }
  ],
  "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,
  "auto_create_indexes": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

PATCH

namespaces

{namespace_identifier}

Partially Update Namespace

curl --request PATCH \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "spotify_playlists_prod",
  "description": "<string>",
  "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
}
'

{
  "namespace_name": "spotify_playlists_dev",
  "namespace_id": "<string>",
  "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"
  },
  "description": "<string>",
  "feature_extractors": [
    {
      "feature_extractor_name": "<string>",
      "version": "<string>",
      "feature_extractor_id": "<string>"
    }
  ],
  "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,
  "auto_create_indexes": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

Authorization

string

required

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

Path Parameters

namespace_identifier

string

required

Either the namespace name or namespace ID

Body

application/json

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

namespace_name

string | null

Updated name for the namespace

Example:

"spotify_playlists_prod"

description

string | null

Updated description for the namespace

payload_indexes

PayloadIndexConfig · object[] | null

Updated list of custom payload indexes for this namespace.

Show child attributes

payload_indexes.field_name

string

required

Name of the payload field to index. Must be unique within the namespace. Use dot notation for nested fields (e.g., 'metadata.title'). Cannot use protected system field names when is_protected=False.

Required string length: 1 - 255

payload_indexes.type

enum<string>

required

Data type of the indexed field. Determines query capabilities and storage optimization. TEXT: Full-text search. KEYWORD: Exact matching, filtering. INTEGER/FLOAT: Range queries, sorting. DATETIME: Temporal queries. GEO: Geospatial queries. BOOL: Boolean filtering. UUID: Unique identifier matching.

Available options:

keyword,

integer,

float,

bool,

geo,

datetime,

text,

uuid

payload_indexes.field_schema

TextIndexParams · object

Optional schema configuration for the index. If not provided, uses default parameters for the specified type. Different types support different parameters (e.g., KeywordIndexParams.is_tenant).

Show child attributes

payload_indexes.field_schema.type

string

default:text

payload_indexes.field_schema.tokenizer

enum<string>

default:word

Tokenizer type.

Available options:

word,

whitespace,

prefix,

multilingual

payload_indexes.field_schema.min_token_len

integer

default:2

payload_indexes.field_schema.max_token_len

integer

default:15

payload_indexes.field_schema.lowercase

boolean

default:true

payload_indexes.is_protected

boolean

default:false

Whether this index is system-managed and cannot be modified by users. Protected indexes (is_protected=True) are created automatically by Mixpeek and are essential for internal operations like tenant isolation, lineage tracking, and document management. Users cannot create, modify, or delete protected indexes. User-created indexes always have is_protected=False.

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

Response

Successful Response

Namespace model.

namespace_name

string

required

Name of the namespace

Example:

"spotify_playlists_dev"

namespace_id

string

Unique identifier for the namespace

infrastructure

NamespaceInfrastructure · object

Infrastructure configuration for the namespace (Ray, Qdrant).

Show child attributes

infrastructure.qdrant_collection

string

required

Qdrant collection backing this namespace's vector data.

Required string length: 3 - 128

infrastructure.ray_cluster_id

string | null

Dedicated Ray cluster identifier for this namespace.

Example:

"ray_shared"

infrastructure.ray_head_node_url

string | null

Ray head node address for job submission (ray://host:port).

Example:

"ray://shared-cluster:10001"

infrastructure.ray_dashboard_url

string | null

Ray dashboard URL for monitoring (http://host:8265).

Example:

"http://ray-dashboard-prod:8265"

infrastructure.qdrant_url

string | null

Dedicated Qdrant instance URL for this namespace. When set, this namespace uses its own Qdrant instance instead of organization or shared infrastructure. Format: http://hostname:port or https://hostname:port. REQUIRED when compute_tier is DEDICATED_CPU or DEDICATED_GPU. NOT REQUIRED for SHARED tier (inherits from organization or uses shared).

Example:

"http://qdrant-ns-prod:6333"

infrastructure.qdrant_api_key

string | null

API key for dedicated Qdrant instance. REQUIRED when qdrant_url is set. NOT REQUIRED for shared tier.

Example:

"qdrant_key_namespace_123"

infrastructure.compute_tier

enum<string>

default:shared

Compute tier controlling isolation and performance characteristics.

Available options:

shared,

dedicated_cpu,

dedicated_gpu

infrastructure.max_concurrent_jobs

integer

default:10

Maximum concurrent Ray jobs allowed for the namespace.

Required range: 1 <= x <= 1000

infrastructure.autoscaling_enabled

boolean

default:true

Toggle autoscaling for dedicated clusters (ignored for shared tier).

infrastructure.min_workers

integer

default:1

Lower bound for Ray workers when autoscaling is enabled.

Required range: 0 <= x <= 100

infrastructure.max_workers

integer

default:10

Upper bound for Ray workers when autoscaling is enabled.

Required range: 1 <= x <= 100

infrastructure.gpu_type

string | null

GPU type for dedicated GPU clusters (e.g. A100, T4).

Example:

"A100"

infrastructure.gpus_per_worker

integer

default:1

Number of GPUs allocated to each Ray worker when using GPUs.

Required range: 0 <= x <= 8

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

description

string | null

Description of the namespace

feature_extractors

BaseFeatureExtractorModel · object[]

List of feature extractors configured for this namespace

Show child attributes

feature_extractors.feature_extractor_name

string

required

Name of the feature extractor

feature_extractors.version

string

required

Version of the feature extractor

feature_extractors.feature_extractor_id

string

required

Construct unique identifier for the feature extractor instance (name + version).

payload_indexes

PayloadIndexConfig · object[] | null

Custom payload indexes configured for this namespace

Show child attributes

payload_indexes.field_name

string

required

Name of the payload field to index. Must be unique within the namespace. Use dot notation for nested fields (e.g., 'metadata.title'). Cannot use protected system field names when is_protected=False.

Required string length: 1 - 255

payload_indexes.type

enum<string>

required

Available options:

keyword,

integer,

float,

bool,

geo,

datetime,

text,

uuid

payload_indexes.field_schema

TextIndexParams · object

Optional schema configuration for the index. If not provided, uses default parameters for the specified type. Different types support different parameters (e.g., KeywordIndexParams.is_tenant).

Show child attributes

payload_indexes.field_schema.type

string

default:text

payload_indexes.field_schema.tokenizer

enum<string>

default:word

Tokenizer type.

Available options:

word,

whitespace,

prefix,

multilingual

payload_indexes.field_schema.min_token_len

integer

default:2

payload_indexes.field_schema.max_token_len

integer

default:15

payload_indexes.field_schema.lowercase

boolean

default:true

payload_indexes.is_protected

boolean

default:false

document_count

integer | null

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

auto_create_indexes

boolean

default:false

created_at

string<date-time> | null

When the namespace was created

updated_at

string<date-time> | null

When the namespace was last updated

Update Namespace List Namespaces

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

Partially Update Namespace

Headers

Path Parameters

Body

Response