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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

namespace_identifier
string
required

Namespace name or ID

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

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: the namespace's records without its vector points. Restoring it writes no vectors, so it is not a backup of the namespace's data.

import_from
SnapshotImportSource · object | null

Import a snapshot taken on another plane instead of taking one: its artifacts are copied from this bucket and prefix into this namespace's snapshots, every artifact is checked against the sha256 its manifest records, and the snapshot is completed only if verify finds it restorable. copy_s3_objects and include_vectors do not apply.

Response

Successful Response

task_id
string
required
snapshot_id
string
required
message
string
required