Create Migration
curl --request POST \
--url https://api.mixpeek.com/v1/namespaces/migrations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"feature_extractors": [
{
"feature_extractor_name": "openai_text_embedding",
"parameters": {
"model": "text-embedding-3-large"
},
"version": "v3"
}
],
"migration_type": "re_extract",
"source_namespace_id": "ns_abc123",
"target_namespace_name": "my_namespace_v2"
},
"start_immediately": false
}
'import requests
url = "https://api.mixpeek.com/v1/namespaces/migrations/"
payload = {
"config": {
"feature_extractors": [
{
"feature_extractor_name": "openai_text_embedding",
"parameters": { "model": "text-embedding-3-large" },
"version": "v3"
}
],
"migration_type": "re_extract",
"source_namespace_id": "ns_abc123",
"target_namespace_name": "my_namespace_v2"
},
"start_immediately": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
feature_extractors: [
{
feature_extractor_name: 'openai_text_embedding',
parameters: {model: 'text-embedding-3-large'},
version: 'v3'
}
],
migration_type: 're_extract',
source_namespace_id: 'ns_abc123',
target_namespace_name: 'my_namespace_v2'
},
start_immediately: false
})
};
fetch('https://api.mixpeek.com/v1/namespaces/migrations/', 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/namespaces/migrations/",
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([
'config' => [
'feature_extractors' => [
[
'feature_extractor_name' => 'openai_text_embedding',
'parameters' => [
'model' => 'text-embedding-3-large'
],
'version' => 'v3'
]
],
'migration_type' => 're_extract',
'source_namespace_id' => 'ns_abc123',
'target_namespace_name' => 'my_namespace_v2'
],
'start_immediately' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/namespaces/migrations/"
payload := strings.NewReader("{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/namespaces/migrations/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/namespaces/migrations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2025-12-03T10:00:00Z",
"message": "Migration created successfully. Use POST /migrations/{id}/start to begin execution.",
"migration_id": "mig_abc123xyz789",
"status": "draft",
"validation_result": {
"errors": [],
"estimated_duration_seconds": 1800,
"estimated_resources": {
"cluster": 1,
"collection": 5,
"taxonomy": 2
},
"valid": true,
"warnings": []
}
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Migrations
Create Migration
Create a new namespace migration.
This endpoint creates a migration and optionally validates it. Use start_immediately=True to begin execution immediately.
Args: request: FastAPI request create_request: Migration configuration
Returns: CreateMigrationResponse with migration ID and status
POST
/
v1
/
namespaces
/
migrations
/
Create Migration
curl --request POST \
--url https://api.mixpeek.com/v1/namespaces/migrations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"feature_extractors": [
{
"feature_extractor_name": "openai_text_embedding",
"parameters": {
"model": "text-embedding-3-large"
},
"version": "v3"
}
],
"migration_type": "re_extract",
"source_namespace_id": "ns_abc123",
"target_namespace_name": "my_namespace_v2"
},
"start_immediately": false
}
'import requests
url = "https://api.mixpeek.com/v1/namespaces/migrations/"
payload = {
"config": {
"feature_extractors": [
{
"feature_extractor_name": "openai_text_embedding",
"parameters": { "model": "text-embedding-3-large" },
"version": "v3"
}
],
"migration_type": "re_extract",
"source_namespace_id": "ns_abc123",
"target_namespace_name": "my_namespace_v2"
},
"start_immediately": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
feature_extractors: [
{
feature_extractor_name: 'openai_text_embedding',
parameters: {model: 'text-embedding-3-large'},
version: 'v3'
}
],
migration_type: 're_extract',
source_namespace_id: 'ns_abc123',
target_namespace_name: 'my_namespace_v2'
},
start_immediately: false
})
};
fetch('https://api.mixpeek.com/v1/namespaces/migrations/', 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/namespaces/migrations/",
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([
'config' => [
'feature_extractors' => [
[
'feature_extractor_name' => 'openai_text_embedding',
'parameters' => [
'model' => 'text-embedding-3-large'
],
'version' => 'v3'
]
],
'migration_type' => 're_extract',
'source_namespace_id' => 'ns_abc123',
'target_namespace_name' => 'my_namespace_v2'
],
'start_immediately' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/namespaces/migrations/"
payload := strings.NewReader("{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/namespaces/migrations/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/namespaces/migrations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"feature_extractors\": [\n {\n \"feature_extractor_name\": \"openai_text_embedding\",\n \"parameters\": {\n \"model\": \"text-embedding-3-large\"\n },\n \"version\": \"v3\"\n }\n ],\n \"migration_type\": \"re_extract\",\n \"source_namespace_id\": \"ns_abc123\",\n \"target_namespace_name\": \"my_namespace_v2\"\n },\n \"start_immediately\": false\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2025-12-03T10:00:00Z",
"message": "Migration created successfully. Use POST /migrations/{id}/start to begin execution.",
"migration_id": "mig_abc123xyz789",
"status": "draft",
"validation_result": {
"errors": [],
"estimated_duration_seconds": 1800,
"estimated_resources": {
"cluster": 1,
"collection": 5,
"taxonomy": 2
},
"valid": true,
"warnings": []
}
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"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.
Body
application/json
Response
Successful Response
Response after creating a migration.
Created migration ID
Current status
Available options:
draft, validating, pending, in_progress, completed, failed, cancelled Creation timestamp
Human-readable message
Validation result if available
Show child attributes
Show child attributes
Was this page helpful?
⌘I