Get Migration

curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}', 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/{migration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "migration_id": "<string>",
  "internal_id": "<string>",
  "namespace_id": "<string>",
  "config": {
    "source_namespace_id": "<string>",
    "target_namespace_id": "<string>",
    "target_namespace_name": "<string>",
    "feature_extractors": [
      {
        "feature_extractor_name": "<string>",
        "version": "<string>",
        "parameters": {}
      }
    ],
    "filters": {
      "collection_ids": [
        "<string>"
      ],
      "taxonomy_ids": [
        "<string>"
      ],
      "cluster_ids": [
        "<string>"
      ],
      "retriever_ids": [
        "<string>"
      ],
      "date_range": {},
      "auto_include_dependencies": true
    },
    "batch_options": {
      "batch_size": 100,
      "max_workers": 10,
      "retry_failed": true
    },
    "taxonomy_options": {
      "preserve_taxonomy_ids": true,
      "preserve_enrichment_fields": true,
      "re_run_enrichment": false,
      "migrate_reference_collections": true
    },
    "cluster_options": {
      "preserve_cluster_ids": true,
      "preserve_assignments": true,
      "migrate_artifacts": true,
      "preserve_centroids": true,
      "recompute_clusters": false
    },
    "retriever_options": {
      "preserve_retriever_ids": false,
      "migrate_interactions": false,
      "migrate_execution_history": false,
      "validate_references": true
    },
    "preserve_resource_ids": false,
    "dry_run": false,
    "webhook_url": "<string>"
  },
  "progress": {
    "overall_progress_percent": 0,
    "stages": [
      {
        "started_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "progress_percent": 0,
        "items_total": 0,
        "items_completed": 0,
        "items_failed": 0,
        "error_message": "<string>"
      }
    ],
    "resources": [
      {
        "resource_id": "<string>",
        "progress_percent": 0,
        "error_message": "<string>"
      }
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "estimated_completion": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "validation_result": {
    "valid": true,
    "errors": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>",
        "input": "<unknown>",
        "ctx": {}
      }
    ],
    "warnings": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>",
        "input": "<unknown>",
        "ctx": {}
      }
    ],
    "estimated_resources": {},
    "estimated_duration_seconds": 123
  },
  "dependency_graph": {
    "nodes": [
      {
        "resource_id": "<string>",
        "dependencies": [
          "<string>"
        ],
        "tier": 0
      }
    ],
    "execution_order": [
      "<string>"
    ]
  },
  "task_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "additional_data": {}
}

{
  "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
}

GET

namespaces

migrations

{migration_id}

Get Migration

curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}', 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/{migration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/namespaces/migrations/{migration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "migration_id": "<string>",
  "internal_id": "<string>",
  "namespace_id": "<string>",
  "config": {
    "source_namespace_id": "<string>",
    "target_namespace_id": "<string>",
    "target_namespace_name": "<string>",
    "feature_extractors": [
      {
        "feature_extractor_name": "<string>",
        "version": "<string>",
        "parameters": {}
      }
    ],
    "filters": {
      "collection_ids": [
        "<string>"
      ],
      "taxonomy_ids": [
        "<string>"
      ],
      "cluster_ids": [
        "<string>"
      ],
      "retriever_ids": [
        "<string>"
      ],
      "date_range": {},
      "auto_include_dependencies": true
    },
    "batch_options": {
      "batch_size": 100,
      "max_workers": 10,
      "retry_failed": true
    },
    "taxonomy_options": {
      "preserve_taxonomy_ids": true,
      "preserve_enrichment_fields": true,
      "re_run_enrichment": false,
      "migrate_reference_collections": true
    },
    "cluster_options": {
      "preserve_cluster_ids": true,
      "preserve_assignments": true,
      "migrate_artifacts": true,
      "preserve_centroids": true,
      "recompute_clusters": false
    },
    "retriever_options": {
      "preserve_retriever_ids": false,
      "migrate_interactions": false,
      "migrate_execution_history": false,
      "validate_references": true
    },
    "preserve_resource_ids": false,
    "dry_run": false,
    "webhook_url": "<string>"
  },
  "progress": {
    "overall_progress_percent": 0,
    "stages": [
      {
        "started_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "progress_percent": 0,
        "items_total": 0,
        "items_completed": 0,
        "items_failed": 0,
        "error_message": "<string>"
      }
    ],
    "resources": [
      {
        "resource_id": "<string>",
        "progress_percent": 0,
        "error_message": "<string>"
      }
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "estimated_completion": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "validation_result": {
    "valid": true,
    "errors": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>",
        "input": "<unknown>",
        "ctx": {}
      }
    ],
    "warnings": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>",
        "input": "<unknown>",
        "ctx": {}
      }
    ],
    "estimated_resources": {},
    "estimated_duration_seconds": 123
  },
  "dependency_graph": {
    "nodes": [
      {
        "resource_id": "<string>",
        "dependencies": [
          "<string>"
        ],
        "tier": 0
      }
    ],
    "execution_order": [
      "<string>"
    ]
  },
  "task_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "additional_data": {}
}

{
  "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

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.

Path Parameters

migration_id

string

required

Response

Successful Response

Response for getting migration details.

migration_id

string

required

Migration ID

internal_id

string

required

Organization internal ID

namespace_id

string

required

Source namespace ID

config

MigrationConfig · object

required

Migration configuration

Show child attributes

status

enum<string>

required

Current status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

progress

MigrationProgress · object

required

Progress tracking

Show child attributes

created_at

string<date-time>

required

Creation timestamp

validation_result

ValidationResult · object | null

Validation result

Show child attributes

dependency_graph

DependencyGraph · object | null

Dependency graph

Show child attributes

task_id

string | null

Task ID for tracking migration progress

started_at

string<date-time> | null

Start timestamp

completed_at

string<date-time> | null

Completion timestamp

error_message

string | null

Error if failed

additional_data

Additional Data · object

Additional metadata

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

Get Migration

Authorizations

Path Parameters

Response