Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iblueprint.ai/llms.txt

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

The execution.getExecutionStatus procedure reads the current state of a blueprint execution from the database. Poll this endpoint after triggering an async execution with execution.executeBlueprintWithLogging to track progress and detect completion or failure. The progress field (0–100) and completedSteps count update as nodes finish, giving you a live view into long-running workflows.

Request

Procedure type: query (HTTP GET) Endpoint:
GET https://api.iblueprint.ai/api/trpc/execution.getExecutionStatus

Parameters

input
object
required
A URL-encoded JSON object with a json key containing the parameter below.
json.executionId
string
required
The execution ID returned by blueprint.execute or execution.executeBlueprintWithLogging.

Response

id
string
The execution ID.
status
string
Current execution status. One of:
  • running — actively processing nodes
  • completed — all nodes finished successfully
  • failed — one or more nodes failed and execution stopped
  • paused — execution is paused (e.g. awaiting human-in-the-loop input)
  • not_found — no execution record exists for this ID
progress
number
Integer percentage (0–100) of nodes completed.
startTime
string
ISO 8601 timestamp when execution began.
endTime
string
ISO 8601 timestamp when execution finished. null if still running.
totalSteps
number
Total number of nodes in this blueprint run.
completedSteps
number
Number of nodes that have finished successfully.
failedSteps
number
Number of nodes that failed.
steps
array
Array of step-level execution records, each describing an individual node run.
logs
array
Array of log entries produced during execution.
currentStep
string
ID of the node currently executing. undefined if no node is actively running.
awaitingInput
object
Present when status is paused and the blueprint is waiting for user input. Contains details about what input is required.

Polling pattern

Poll the status endpoint at a regular interval until status is completed or failed. A 2–5 second interval is appropriate for most blueprints.
curl -G "https://api.iblueprint.ai/api/trpc/execution.getExecutionStatus" \
  --data-urlencode 'input={"json":{"executionId":"exec_1733050800000_a3b7z"}}' \
  -H "Authorization: Bearer YOUR_API_KEY"

Sample response (in progress)

{
  "result": {
    "data": {
      "json": {
        "id": "exec_1733050800000_a3b7z",
        "status": "running",
        "progress": 50,
        "startTime": "2024-12-01T10:00:00Z",
        "endTime": null,
        "totalSteps": 4,
        "completedSteps": 2,
        "failedSteps": 0,
        "steps": [...],
        "logs": [...],
        "currentStep": "node-3",
        "awaitingInput": null
      }
    }
  }
}

Sample response (completed)

{
  "result": {
    "data": {
      "json": {
        "id": "exec_1733050800000_a3b7z",
        "status": "completed",
        "progress": 100,
        "startTime": "2024-12-01T10:00:00Z",
        "endTime": "2024-12-01T10:00:12Z",
        "totalSteps": 4,
        "completedSteps": 4,
        "failedSteps": 0,
        "steps": [...],
        "logs": [...],
        "currentStep": null,
        "awaitingInput": null
      }
    }
  }
}