Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Scaffold Templates

Get Or Create Default Namespace

Get or create the default universal namespace.

Returns the existing default namespace if one exists, or creates a new one using the universal template. This is the primary onboarding entry point — Studio calls this on first upload to ensure a namespace exists without requiring the user to choose a template.

The default namespace supports all file types (video, image, audio, PDF, text) with pre-configured extractors and a universal retriever.

If the request carries an X-Namespace header that resolves to an existing writable org namespace (e.g. one just created via the wizard), the scaffold is provisioned into THAT namespace instead of creating a "default" one.

post/v1/templates/scaffolds/default

Response

Successful Response

namespace_idstring required

Created namespace ID (ns_xxx)

namespace_namestring required

Created namespace name

bucket_idstring required

Created bucket ID (bkt_xxx)

bucket_namestring required

Created bucket name

collection_idstring required

Created collection ID (col_xxx)

collection_namestring required

Created collection name

retriever_idstring required

Created retriever ID (ret_xxx)

retriever_namestring required

Created retriever name

template_idstring required

Scaffold template ID used

statusstring

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

task_idstring nullable

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_atstring date-time

UTC timestamp of creation

Example response

{
  "bucket_id": "bkt_xyz789",
  "bucket_name": "videos",
  "collection_id": "col_def456",
  "collection_name": "video_embeddings",
  "created_at": "2025-01-15T12:00:00Z",
  "namespace_id": "ns_abc123",
  "namespace_name": "my_video_app",
  "retriever_id": "ret_ghi012",
  "retriever_name": "video_search",
  "status": "created",
  "template_id": "tmpl_scaffold_video_understanding"
}