Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Namespace 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/

Request body

start_immediatelyboolean

Start execution immediately after validation

Example request

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

Response

Successful Response

migration_idstring required

Created migration ID

status'draft' | 'validating' | 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required

Migration execution status.

created_atstring date-time required

Creation timestamp

messagestring required

Human-readable message

Example response

{
  "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": []
  }
}