Skip to main content
POST
Validate an import mapping

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.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Body

application/json

Request body for POST /v1/collections/import/validate-mapping.

mapping
ImportMapping · object
required

The finalized source->target mapping to validate.

source_fields
SourceField · object[]

The declared source fields.

known_index_dims
Known Index Dims · object | null

Known target vector index dims, for dim-mismatch checks.

Response

Successful Response

ok
boolean
required
errors
MappingValidationError · object[]