List Run Commands | BCTRL Docs

curl https://api.bctrl.ai/v1/runs/id/commands \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "commands": [
    {
      "artifactCount": 3,
      "createdAt": "2024-06-10T15:22:30Z",
      "entryCall": "invokeWorkflow",
      "executionMode": "inline",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "runId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "runtimeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "runtimeKind": "browser",
      "sequenceNo": 12,
      "spaceId": "9f8c7d6e-5b4a-3210-9876-54321fedcba0",
      "status": "succeeded",
      "stepCount": 5,
      "cancelRequestedAt": null,
      "connector": "github",
      "correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "durationMs": 2450,
      "error": null,
      "finishedAt": "2024-06-10T15:22:32Z",
      "lastHeartbeatAt": "2024-06-10T15:22:31Z",
      "metadata": {
        "environment": "production",
        "trigger": "manual"
      },
      "progress": {
        "currentCall": "step2",
        "lastEventType": "step_completed",
        "message": "Processing step 2 of 5",
        "step": 2,
        "totalSteps": 5
      },
      "request": {
        "runtimeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "steps": [
          {
            "call": "initialize",
            "args": [
              "param1",
              42,
              true
            ],
            "bind": "step1",
            "options": {
              "dryRun": false,
              "timeoutMs": 30000
            },
            "ref": "initRef"
          }
        ],
        "idempotencyKey": "run-20240610-152230",
        "mode": "fail-fast"
      },
      "result": {
        "mode": "fail-fast",
        "ok": true,
        "runtimeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "steps": [
          {
            "binding": {
              "alias": "mainPage",
              "id": "page-1234",
              "type": "page"
            },
            "call": "loadPage",
            "index": 0,
            "ok": true,
            "resolved": {
              "call": "loadPage",
              "contextId": "ctx-5678",
              "handleId": "handle-9012",
              "method": "GET",
              "pageId": "page-1234",
              "ref": "ref-abc",
              "runtimeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
              "target": "https://example.com"
            }
          }
        ]
      },
      "startedAt": "2024-06-10T15:22:29Z"
    }
  ],
  "nextCursor": "13"
}

List platform command records for a run. Use this to review requested BCTRL operations such as hosted invocations and runtime actions; external connection automation is available in run events as connection.command.*.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Query parameters

cursorstringOptionalformat: "^[1-9]\d*$"

limitintegerOptional<=200

orderenumOptional

Allowed values:

statusstring or list of stringsOptional

executionModestring or list of stringsOptional

includestring or list of stringsOptional

Response

Default Response

commandslist of objects

nextCursorstring or null