Start a run

POST

migrations

{migration_id}

runs

curl --request POST \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "kind": "generate"
}
'

{
  "run_id": "d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8",
  "status": "queued",
  "poll_url": "https://app.vern.so/api/v1/migrations/c0a8012e-.../runs/d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "A run is already in progress for this migration.",
  "run_id": "d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8"
}

{
  "error": "Too many requests"
}

Authorizations

x-api-key

string

header

required

Your Vern API key. Create one at Settings → API keys.

Path Parameters

migration_id

string<uuid>

required

The migration ID returned by Create a migration.

Body

application/json

kind

enum<string>

required

Available options:

generate,

update,

clarify,

execute

message

string

Required for update and clarify — your instruction or question in plain language.

extract_via_api

boolean

generate only. Controls live API extraction from a connected source: true extracts via the connection (alongside any files), false forces file-only, omitted extracts via API only when no files were uploaded and a connection exists.

Response

The run was accepted. A generate is queued; a resuming update/clarify/execute is running. Poll poll_url.

run_id

string<uuid>

status

string

Example:

"queued"

poll_url

string<uri>

Poll a runRead a run's state. Every response carries `run_id`, `status`, and `created_at` (plus `answers`, a read-back of your last reply, once you've answered a block); the rest depends on status (`message` while running, `blocked_reason` + `questions`/`credential_request` when blocked, `report` on a completed execute, `error` on failure).

curl --request POST \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "kind": "generate"
}
'

{
  "run_id": "d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8",
  "status": "queued",
  "poll_url": "https://app.vern.so/api/v1/migrations/c0a8012e-.../runs/d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "A run is already in progress for this migration.",
  "run_id": "d4c3b2a1-9f8e-47d6-b5a4-c3d2e1f0a9b8"
}

{
  "error": "Too many requests"
}

Overview

Catalog

Migrations

Runs

Export

Authorizations

Path Parameters

Body

Response