Import external documents into a collection
curl --request POST \
--url https://api.mixpeek.com/v1/collections/{collection_identifier}/import \
--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": {}
},
"export": {},
"explode": {
"explode_axis": "<string>",
"vector_join": {
"array": "<string>",
"key": "<string>",
"index": "<string>",
"vector_field": "vector_b64"
}
},
"dry_run": false,
"seed_ledger": false
}
'import requests
url = "https://api.mixpeek.com/v1/collections/{collection_identifier}/import"
payload = {
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"export": {},
"explode": {
"explode_axis": "<string>",
"vector_join": {
"array": "<string>",
"key": "<string>",
"index": "<string>",
"vector_field": "vector_b64"
}
},
"dry_run": False,
"seed_ledger": False
}
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: {}
},
export: {},
explode: {
explode_axis: '<string>',
vector_join: {
array: '<string>',
key: '<string>',
index: '<string>',
vector_field: 'vector_b64'
}
},
dry_run: false,
seed_ledger: false
})
};
fetch('https://api.mixpeek.com/v1/collections/{collection_identifier}/import', 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/{collection_identifier}/import",
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' => [
]
],
'export' => [
],
'explode' => [
'explode_axis' => '<string>',
'vector_join' => [
'array' => '<string>',
'key' => '<string>',
'index' => '<string>',
'vector_field' => 'vector_b64'
]
],
'dry_run' => false,
'seed_ledger' => false
]),
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/{collection_identifier}/import"
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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\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/{collection_identifier}/import")
.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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/{collection_identifier}/import")
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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\n}"
response = http.request(request)
puts response.read_body{
"imported": 0,
"reconstructed": 0,
"skipped": 0,
"dry_run": false,
"errors": [
{
"row": 123,
"error": "<string>"
}
],
"warnings": [
"<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
}Import
Import external documents into a collection
Reconstruct documents (with vectors + lineage) from one external export using a validated mapping, and write them into the collection via the BYO write core. Use /import/infer and /import/validate-mapping first; dry_run reconstructs and validates without writing.
POST
/
v1
/
collections
/
{collection_identifier}
/
import
Import external documents into a collection
curl --request POST \
--url https://api.mixpeek.com/v1/collections/{collection_identifier}/import \
--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": {}
},
"export": {},
"explode": {
"explode_axis": "<string>",
"vector_join": {
"array": "<string>",
"key": "<string>",
"index": "<string>",
"vector_field": "vector_b64"
}
},
"dry_run": false,
"seed_ledger": false
}
'import requests
url = "https://api.mixpeek.com/v1/collections/{collection_identifier}/import"
payload = {
"mapping": {
"fields": [
{
"source_field": "<string>",
"target": {
"path": "<string>",
"index": "<string>",
"dim": 123,
"dtype": "<string>",
"chain_position": 123
}
}
],
"chain_template": {}
},
"export": {},
"explode": {
"explode_axis": "<string>",
"vector_join": {
"array": "<string>",
"key": "<string>",
"index": "<string>",
"vector_field": "vector_b64"
}
},
"dry_run": False,
"seed_ledger": False
}
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: {}
},
export: {},
explode: {
explode_axis: '<string>',
vector_join: {
array: '<string>',
key: '<string>',
index: '<string>',
vector_field: 'vector_b64'
}
},
dry_run: false,
seed_ledger: false
})
};
fetch('https://api.mixpeek.com/v1/collections/{collection_identifier}/import', 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/{collection_identifier}/import",
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' => [
]
],
'export' => [
],
'explode' => [
'explode_axis' => '<string>',
'vector_join' => [
'array' => '<string>',
'key' => '<string>',
'index' => '<string>',
'vector_field' => 'vector_b64'
]
],
'dry_run' => false,
'seed_ledger' => false
]),
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/{collection_identifier}/import"
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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\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/{collection_identifier}/import")
.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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/{collection_identifier}/import")
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 \"export\": {},\n \"explode\": {\n \"explode_axis\": \"<string>\",\n \"vector_join\": {\n \"array\": \"<string>\",\n \"key\": \"<string>\",\n \"index\": \"<string>\",\n \"vector_field\": \"vector_b64\"\n }\n },\n \"dry_run\": false,\n \"seed_ledger\": false\n}"
response = http.request(request)
puts response.read_body{
"imported": 0,
"reconstructed": 0,
"skipped": 0,
"dry_run": false,
"errors": [
{
"row": 123,
"error": "<string>"
}
],
"warnings": [
"<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.
Path Parameters
The ID or name of the collection to import into
Body
application/json
Request body for POST /v1/collections/{collection_id}/import.
The finalized source->target mapping (validate it first).
Show child attributes
Show child attributes
One export object (e.g. an asset with its scene arrays).
Document-explosion inputs when the export nests a doc-generating array.
Show child attributes
Show child attributes
Reconstruct and validate only; write nothing.
Seed the ledger for heal-skip (no-op until available).
Response
Successful Response
Result of a collection import.
Was this page helpful?