curl --request POST \
--url https://api.mixpeek.com/v1/collections/import/validate-mapping \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"source_fields": [
{
"path": "<string>"
}
],
"known_index_dims": {}
}
'import requests
url = "https://api.mixpeek.com/v1/collections/import/validate-mapping"
payload = {
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"source_fields": [{ "path": "<string>" }],
"known_index_dims": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
mapping: {
fields: [
{
source_field: '<string>',
target: {
path: '<string>',
index: '<string>',
dim: 123,
dtype: '<string>',
chain_position: 123
}
}
],
chain_template: {}
},
source_fields: [{path: '<string>'}],
known_index_dims: {}
})
};
fetch('https://api.mixpeek.com/v1/collections/import/validate-mapping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/collections/import/validate-mapping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mapping' => [
'fields' => [
[
'source_field' => '<string>',
'target' => [
'path' => '<string>',
'index' => '<string>',
'dim' => 123,
'dtype' => '<string>',
'chain_position' => 123
]
]
],
'chain_template' => [
]
],
'source_fields' => [
[
'path' => '<string>'
]
],
'known_index_dims' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/collections/import/validate-mapping"
payload := strings.NewReader("{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/collections/import/validate-mapping")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/import/validate-mapping")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"errors": [
{
"error": "<string>",
"field": "<string>"
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Validate an import mapping
Validate a finalized source->target mapping before any import. Flags a missing root-identity mapping, source/target type mismatches, vector-dim mismatches against a known index, and unknown source fields.
curl --request POST \
--url https://api.mixpeek.com/v1/collections/import/validate-mapping \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"source_fields": [
{
"path": "<string>"
}
],
"known_index_dims": {}
}
'import requests
url = "https://api.mixpeek.com/v1/collections/import/validate-mapping"
payload = {
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"source_fields": [{ "path": "<string>" }],
"known_index_dims": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
mapping: {
fields: [
{
source_field: '<string>',
target: {
path: '<string>',
index: '<string>',
dim: 123,
dtype: '<string>',
chain_position: 123
}
}
],
chain_template: {}
},
source_fields: [{path: '<string>'}],
known_index_dims: {}
})
};
fetch('https://api.mixpeek.com/v1/collections/import/validate-mapping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/collections/import/validate-mapping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mapping' => [
'fields' => [
[
'source_field' => '<string>',
'target' => [
'path' => '<string>',
'index' => '<string>',
'dim' => 123,
'dtype' => '<string>',
'chain_position' => 123
]
]
],
'chain_template' => [
]
],
'source_fields' => [
[
'path' => '<string>'
]
],
'known_index_dims' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/collections/import/validate-mapping"
payload := strings.NewReader("{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/collections/import/validate-mapping")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/import/validate-mapping")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mapping\": {\n \"fields\": [\n {\n \"source_field\": \"<string>\",\n \"target\": {\n \"path\": \"<string>\",\n \"index\": \"<string>\",\n \"dim\": 123,\n \"dtype\": \"<string>\",\n \"chain_position\": 123\n }\n }\n ],\n \"chain_template\": {}\n },\n \"source_fields\": [\n {\n \"path\": \"<string>\"\n }\n ],\n \"known_index_dims\": {}\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"errors": [
{
"error": "<string>",
"field": "<string>"
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
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.
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
Request body for POST /v1/collections/import/validate-mapping.
The finalized source->target mapping to validate.
Show child attributes
Show child attributes
The declared source fields.
Show child attributes
Show child attributes
Known target vector index dims, for dim-mismatch checks.
Show child attributes
Show child attributes
Was this page helpful?

