Skip to main content
POST
/
v1
/
namespaces
/
migrations
/
validate
Validate Migration
curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/migrations/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>"
  }
}
'
{
  "message": "Configuration is valid with 1 warning",
  "validation_result": {
    "errors": [],
    "estimated_duration_seconds": 1800,
    "estimated_resources": {
      "collection": 5,
      "taxonomy": 2
    },
    "valid": true,
    "warnings": [
      {
        "error_code": "RE_EXTRACT_COST_WARNING",
        "message": "RE_EXTRACT migration will reprocess all documents and incur processing costs",
        "severity": "warning"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

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

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Body

application/json

Request to validate a migration configuration without creating it.

​
config
MigrationConfig · object
required

Migration configuration

Response

Successful Response

Response for migration validation.

​
validation_result
ValidationResult · object
required

Validation result

​
message
string
required

Human-readable message

​
dependency_graph
DependencyGraph · object

Dependency graph if validation passed