Clone Namespace

curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/clone \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "<string>",
  "include_resources": {
    "collections": true,
    "retrievers": true,
    "taxonomies": false
  },
  "description": "Staging clone from production",
  "source_organization_id": "org_abc123"
}
'

{
  "namespace": {
    "namespace_name": "product-search",
    "object": "namespace",
    "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>",
        "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"
  },
  "source_namespace_id": "<string>",
  "status": "cloning",
  "task_id": "<string>",
  "cloned_resources": {
    "collections": 0,
    "retrievers": 0,
    "taxonomies": 0,
    "buckets": 0,
    "objects": 0,
    "points": 0
  },
  "primary_retriever_id": "<string>"
}

Clone

Clone Namespace

Clone a namespace with all its data.

What gets cloned:

Namespace configuration (extractors, payload indexes)
Buckets (metadata, references same S3 files)
Collections (full copy of all vectors/embeddings)
Retrievers (pipeline configuration)

Use Cases:

Create staging environment from production
Backup namespace with all data
Fork namespace for experimentation

For config-only copy (no data), use templates instead:

POST /templates/namespaces/from-namespace/
POST /templates/namespaces//instantiate

POST

namespaces

{namespace_identifier}

clone

Clone Namespace

curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/clone \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_name": "<string>",
  "include_resources": {
    "collections": true,
    "retrievers": true,
    "taxonomies": false
  },
  "description": "Staging clone from production",
  "source_organization_id": "org_abc123"
}
'

{
  "namespace": {
    "namespace_name": "product-search",
    "object": "namespace",
    "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>",
        "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"
  },
  "source_namespace_id": "<string>",
  "status": "cloning",
  "task_id": "<string>",
  "cloned_resources": {
    "collections": 0,
    "retrievers": 0,
    "taxonomies": 0,
    "buckets": 0,
    "objects": 0,
    "points": 0
  },
  "primary_retriever_id": "<string>"
}

Headers

Authorization

string

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

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

Path Parameters

namespace_identifier

string

required

Source namespace ID or name to clone from

Body

application/json

Request to clone a namespace with all its data.

Clone creates a full copy of a namespace including:

Namespace configuration (extractors, indexes)
Buckets (metadata, references same S3 files)
Collections (full copy of all vectors/embeddings)
Retrievers (pipeline configuration)

Use Cases:

Create staging environment from production
Backup namespace with all data
Fork namespace for experimentation

For config-only copy (no data), use templates instead:

POST /templates/namespaces/from-namespace/{id}
POST /templates/namespaces/{template_id}/instantiate

namespace_name

string

required

Name for the cloned namespace (must be unique)

Minimum string length: 1

Examples:

"production_staging"

"backup_2024_01"

include_resources

CloneNamespaceResourcesConfig · object

Which resources to include. Defaults to collections + retrievers.

Show child attributes

description

string | null

Override description. If omitted, copies from source.

Example:

"Staging clone from production"

source_organization_id

string | null

Source org ID for cross-org cloning (admin only).

Example:

"org_abc123"

Response

Successful Response

Response after initiating namespace clone.

namespace

NamespaceModel · object

required

Cloned namespace with new namespace_id

Show child attributes

source_namespace_id

string

required

Source namespace that was cloned

status

string

default:cloning

Clone status: 'cloning', 'ready', or 'failed'

task_id

string | null

Task ID for tracking clone progress

cloned_resources

ClonedResourceSummary · object

Summary of cloned resources (present when ready)

Show child attributes

primary_retriever_id

string | null

Pre-allocated retriever ID for the primary cloned retriever. Present immediately so callers can navigate to the retriever detail page while the background task hydrates the rest of the data. None if source namespace has no retrievers.

Delete Namespace Create Migration