Skip to main content
POST
Get Or Create Default Namespace

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.

Response

Successful Response

Response after successful scaffold instantiation.

Contains IDs and names of all four created resources. Use these IDs for subsequent operations:

  • Upload data: POST /v1/buckets/{bucket_id}/objects
  • Process: POST /v1/collections/{collection_id}/batches
  • Search: POST /v1/retrievers/{retriever_id}/retrieve
namespace_id
string
required

Created namespace ID (ns_xxx)

namespace_name
string
required

Created namespace name

bucket_id
string
required

Created bucket ID (bkt_xxx)

bucket_name
string
required

Created bucket name

collection_id
string
required

Created collection ID (col_xxx)

collection_name
string
required

Created collection name

retriever_id
string
required

Created retriever ID (ret_xxx)

retriever_name
string
required

Created retriever name

template_id
string
required

Scaffold template ID used

status
string
default:created

Status: 'created' for a synchronous (empty) instantiation, 'cloning' when sample data is cloning in the background

task_id
string | null

Background clone task id when status='cloning' — poll the task, or GET the namespace and read clone_status, to track sample-data progress. Null for synchronous (empty) instantiation.

created_at
string<date-time>

UTC timestamp of creation