Skip to main content
POST
Create Namespace Snapshot

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

Namespace name or ID

Body

application/json
copy_s3_objects
boolean
default:false

If true, S3 objects are copied to the snapshot prefix (slower, uses more storage). Required for restoring after namespace deletion.

include_vectors
boolean
default:true

If false, creates a METADATA-ONLY snapshot (no vector export). Advanced — on restore the vectors are stitched from the shard representative's export (see). Daily sweeps use this to coalesce the full-dataset vector export to one per physical shard.

Response

Successful Response

task_id
string
required
snapshot_id
string
required
message
string
required