List Migrations

curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/migrations/list \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft",
  "migration_type": "re_extract",
  "source_namespace_id": "<string>",
  "limit": 20,
  "offset": 0
}
'

{
  "migrations": [
    {
      "migration_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "config": {
        "migration_type": "re_extract",
        "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>"
      },
      "status": "draft",
      "progress": {
        "overall_status": "draft",
        "overall_progress_percent": 0,
        "current_stage": "namespace_setup",
        "stages": [
          {
            "stage": "namespace_setup",
            "status": "draft",
            "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>",
            "resource_type": "bucket",
            "status": "draft",
            "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>"
          }
        ],
        "warnings": [
          {
            "loc": [
              "<string>"
            ],
            "msg": "<string>",
            "type": "<string>"
          }
        ],
        "estimated_resources": {},
        "estimated_duration_seconds": 123
      },
      "dependency_graph": {
        "nodes": [
          {
            "resource_id": "<string>",
            "resource_type": "bucket",
            "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": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

POST

namespaces

migrations

list

List Migrations

curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/migrations/list \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft",
  "migration_type": "re_extract",
  "source_namespace_id": "<string>",
  "limit": 20,
  "offset": 0
}
'

{
  "migrations": [
    {
      "migration_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "config": {
        "migration_type": "re_extract",
        "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>"
      },
      "status": "draft",
      "progress": {
        "overall_status": "draft",
        "overall_progress_percent": 0,
        "current_stage": "namespace_setup",
        "stages": [
          {
            "stage": "namespace_setup",
            "status": "draft",
            "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>",
            "resource_type": "bucket",
            "status": "draft",
            "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>"
          }
        ],
        "warnings": [
          {
            "loc": [
              "<string>"
            ],
            "msg": "<string>",
            "type": "<string>"
          }
        ],
        "estimated_resources": {},
        "estimated_duration_seconds": 123
      },
      "dependency_graph": {
        "nodes": [
          {
            "resource_id": "<string>",
            "resource_type": "bucket",
            "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": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Headers

Authorization

string

required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Body

application/json

Request to list migrations with filters.

status

enum<string> | null

Filter by status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

migration_type

enum<string> | null

Filter by type

Available options:

re_extract,

copy

source_namespace_id

string | null

Filter by source namespace

limit

integer

default:20

Maximum results

Required range: 1 <= x <= 100

offset

integer

default:0

Result offset for pagination

Required range: x >= 0

Response

Successful Response

Response for listing migrations.

migrations

GetMigrationResponse · object[]

required

List of migrations

Show child attributes

migrations.migration_id

string

required

Migration ID

migrations.internal_id

string

required

Organization internal ID

migrations.namespace_id

string

required

Source namespace ID

migrations.config

MigrationConfig · object

required

Migration configuration

Show child attributes

migrations.config.migration_type

enum<string>

required

Type of migration to perform

Available options:

re_extract,

copy

migrations.config.source_namespace_id

string

required

Source namespace ID

migrations.config.target_namespace_id

string | null

Target namespace ID (auto-generated if not provided)

migrations.config.target_namespace_name

string | null

Name for target namespace

migrations.config.feature_extractors

FeatureExtractorConfig · object[] | null

New extractors to use (RE_EXTRACT only)

Show child attributes

migrations.config.feature_extractors.feature_extractor_name

string

required

Name of the extractor

migrations.config.feature_extractors.version

string | null

Version to use

migrations.config.feature_extractors.parameters

Parameters · object

Extractor parameters

migrations.config.filters

ResourceFilter · object

Resource selection filters

Show child attributes

migrations.config.filters.collection_ids

string[] | null

Specific collection IDs to migrate

migrations.config.filters.taxonomy_ids

string[] | null

Specific taxonomy IDs to migrate

migrations.config.filters.cluster_ids

string[] | null

Specific cluster IDs to migrate

migrations.config.filters.retriever_ids

string[] | null

Specific retriever IDs to migrate

migrations.config.filters.date_range

Date Range · object

Date range filter (after, before)

Show child attributes

migrations.config.filters.date_range.{key}

string

migrations.config.filters.auto_include_dependencies

boolean

default:true

Automatically include required dependencies

migrations.config.batch_options

BatchOptions · object

Batch processing options

Show child attributes

migrations.config.batch_options.batch_size

integer

default:100

Documents per batch

Required range: 1 <= x <= 1000

migrations.config.batch_options.max_workers

integer

default:10

Maximum parallel workers

Required range: 1 <= x <= 50

migrations.config.batch_options.retry_failed

boolean

default:true

Retry failed batches

migrations.config.taxonomy_options

TaxonomyOptions · object

Taxonomy migration options

Show child attributes

migrations.config.taxonomy_options.preserve_taxonomy_ids

boolean

default:true

Keep same taxonomy IDs in target

migrations.config.taxonomy_options.preserve_enrichment_fields

boolean

default:true

Keep taxonomy* fields in documents

migrations.config.taxonomy_options.re_run_enrichment

boolean

default:false

Re-run taxonomy enrichment after migration

migrations.config.taxonomy_options.migrate_reference_collections

boolean

default:true

Automatically migrate reference collections

migrations.config.cluster_options

ClusterOptions · object

Cluster migration options

Show child attributes

migrations.config.cluster_options.preserve_cluster_ids

boolean

default:true

Keep same cluster IDs in target

migrations.config.cluster_options.preserve_assignments

boolean

default:true

Keep cluster_id in documents

migrations.config.cluster_options.migrate_artifacts

boolean

default:true

Copy parquet artifacts from S3

migrations.config.cluster_options.preserve_centroids

boolean

default:true

Keep centroid collections

migrations.config.cluster_options.recompute_clusters

boolean

default:false

Recompute clusters instead of copying

migrations.config.retriever_options

RetrieverOptions · object

Retriever migration options

Show child attributes

migrations.config.retriever_options.preserve_retriever_ids

boolean

default:false

Keep same retriever IDs (avoid conflicts)

migrations.config.retriever_options.migrate_interactions

boolean

default:false

Migrate user interaction data

migrations.config.retriever_options.migrate_execution_history

boolean

default:false

Migrate past execution history

migrations.config.retriever_options.validate_references

boolean

default:true

Pre-flight check all references exist

migrations.config.preserve_resource_ids

boolean

default:false

Preserve original resource IDs in target

migrations.config.dry_run

boolean

default:false

Validate only, don't execute

migrations.config.webhook_url

string | null

Webhook URL for status notifications

migrations.status

enum<string>

required

Current status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

migrations.progress

MigrationProgress · object

required

Progress tracking

Show child attributes

migrations.progress.overall_status

enum<string>

required

Overall migration status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

migrations.progress.overall_progress_percent

number

default:0

Overall progress %

Required range: 0 <= x <= 100

migrations.progress.current_stage

enum<string> | null

Currently executing stage

Available options:

namespace_setup,

batch_creation,

batch_processing,

cluster_execution,

taxonomy_enrichment,

benchmark_evaluation,

finalization

migrations.progress.stages

StageProgress · object[]

Progress for each stage

Show child attributes

migrations.progress.stages.stage

enum<string>

required

Stage name

Available options:

namespace_setup,

batch_creation,

batch_processing,

cluster_execution,

taxonomy_enrichment,

benchmark_evaluation,

finalization

migrations.progress.stages.status

enum<string>

required

Stage status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

migrations.progress.stages.started_at

string<date-time> | null

Stage start time

migrations.progress.stages.completed_at

string<date-time> | null

Stage completion time

migrations.progress.stages.progress_percent

number

default:0

Progress %

Required range: 0 <= x <= 100

migrations.progress.stages.items_total

integer

default:0

Total items to process

Required range: x >= 0

migrations.progress.stages.items_completed

integer

default:0

Items completed

Required range: x >= 0

migrations.progress.stages.items_failed

integer

default:0

Items failed

Required range: x >= 0

migrations.progress.stages.error_message

string | null

Error if failed

migrations.progress.resources

ResourceProgress · object[]

Progress for each resource

Show child attributes

migrations.progress.resources.resource_id

string

required

Resource ID

migrations.progress.resources.resource_type

enum<string>

required

Resource type

Available options:

bucket,

collection,

taxonomy,

cluster,

retriever

migrations.progress.resources.status

enum<string>

required

Resource status

Available options:

draft,

validating,

pending,

in_progress,

completed,

failed,

cancelled

migrations.progress.resources.progress_percent

number

default:0

Progress %

Required range: 0 <= x <= 100

migrations.progress.resources.error_message

string | null

Error if failed

migrations.progress.started_at

string<date-time> | null

Migration start time

migrations.progress.estimated_completion

string<date-time> | null

Estimated completion time

migrations.created_at

string<date-time>

required

Creation timestamp

migrations.validation_result

ValidationResult · object

Validation result

Show child attributes

migrations.validation_result.valid

boolean

required

Whether migration can proceed

migrations.validation_result.errors

ValidationError · object[]

Validation errors

Show child attributes

migrations.validation_result.errors.loc

(string | integer)[]

required

migrations.validation_result.errors.msg

string

required

migrations.validation_result.errors.type

string

required

migrations.validation_result.warnings

ValidationError · object[]

Validation warnings

Show child attributes

migrations.validation_result.warnings.loc

(string | integer)[]

required

migrations.validation_result.warnings.msg

string

required

migrations.validation_result.warnings.type

string

required

migrations.validation_result.estimated_resources

Estimated Resources · object

Estimated resource counts

Show child attributes

migrations.validation_result.estimated_resources.{key}

integer

migrations.validation_result.estimated_duration_seconds

integer | null

Estimated migration duration

migrations.dependency_graph

DependencyGraph · object

Dependency graph

Show child attributes

migrations.dependency_graph.nodes

DependencyNode · object[]

All resource nodes

Show child attributes

migrations.dependency_graph.nodes.resource_id

string

required

Resource ID

migrations.dependency_graph.nodes.resource_type

enum<string>

required

Resource type

Available options:

bucket,

collection,

taxonomy,

cluster,

retriever

migrations.dependency_graph.nodes.dependencies

string[]

IDs of resources this depends on

migrations.dependency_graph.nodes.tier

integer

default:0

Dependency tier (0=no deps)

Required range: x >= 0

migrations.dependency_graph.execution_order

string[]

Topologically sorted execution order

migrations.task_id

string | null

Celery task ID

migrations.started_at

string<date-time> | null

Start timestamp

migrations.completed_at

string<date-time> | null

Completion timestamp

migrations.error_message

string | null

Error if failed

migrations.additional_data

Additional Data · object

Additional metadata

total

integer

required

Total count matching filters

limit

integer

required

Results limit

offset

integer

required

Results offset

Delete Migration Start Migration

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

List Migrations

Headers

Body

Response