VEvern-so
Runs

Poll a run

Changed on

Read 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).

get/migrations/{migration_id}/runs/{run_id}

Request

Response

The run's current state.

run_idstring uuid
status'queued' | 'running' | 'blocked' | 'awaiting_approval' | 'completed' | 'failed' | 'canceled'
created_atstring date-time
instructionsstring nullable

The guidance given when the migration was generated (at most 200 characters), carried onto every later leg. Null when none was given.

answersobject nullable

A read-back of your last reply, present once you've answered a block.

messagestring nullable

Present while queued/running.

blocked_reason'question' | 'credentials'

Present when blocked — which kind of block it is.

errorstring

Present when failed.

Changes

  • 9293d74a6a03Revision changes
    • info

      added the optional property to the response with the status

  • aaaced6a1cacRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status