For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Workflows
      • POSTCreate Workflow
      • GETGet Workflow
      • PUTUpdate Workflow
      • DELDelete Workflow
      • PATCHPatch Workflow
      • GETList Workflow Uploads
      • POSTPreview Run
      • GETRuns Summary
      • GETGet Run Steps
      • GETGet Run Overview
      • GETGet Run Data
      • GETDownload Run
      • GETDownload Run Node
      • POSTDuplicate Workflow
        • GETList Runs
        • POSTStart Run
        • GETGet Run
        • GETGet Run Status
        • POSTCancel Run
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API ReferenceworkflowsRuns

Get Run

GET
/api/v1/workflows/:workflow_id/runs/:run_id
GET
/api/v1/workflows/:workflow_id/runs/:run_id
$curl https://api.onepin.ai/api/v1/workflows/workflow_id/runs/run_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": {
3    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "workflow_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5    "status": "completed",
6    "run_number": 42,
7    "token_cost": 350,
8    "created_at": "2024-01-15T09:25:00Z",
9    "updated_at": "2024-01-15T09:50:00Z",
10    "total_nodes": 15,
11    "total_steps": 120,
12    "finished_steps": 120,
13    "usage_summary": {
14      "tokens_used": 350,
15      "api_calls": 12,
16      "errors": 0
17    },
18    "started_at": "2024-01-15T09:30:00Z",
19    "completed_at": "2024-01-15T09:45:00Z",
20    "error": null,
21    "has_export": true,
22    "triggered_by": {
23      "user_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
24      "user_name": "jane.doe@example.com"
25    },
26    "definition_snapshot": {
27      "nodes": [
28        {
29          "id": "node1",
30          "type": "trigger",
31          "config": {
32            "event": "new_message"
33          }
34        },
35        {
36          "id": "node2",
37          "type": "action",
38          "config": {
39            "action_type": "send_email",
40            "parameters": {
41              "recipient": "user@example.com",
42              "subject": "Workflow Run Notification"
43            }
44          }
45        }
46      ],
47      "edges": [
48        {
49          "from": "node1",
50          "to": "node2"
51        }
52      ],
53      "settings": {
54        "retry_on_failure": true,
55        "max_retries": 3
56      }
57    }
58  },
59  "meta": {
60    "request_id": "req_1234567890abcdef",
61    "timestamp": "2024-01-15T09:50:00Z"
62  }
63}

Fetch a workflow run by id.

Includes definition_snapshot — the graph/execution config captured when the run started, returned raw (no config migrations applied) so it reflects the workflow exactly as it existed for this run.

Was this page helpful?
Previous

Get Run Status

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"
run_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Response

Successful Response
dataobject

Run detail response, including the graph/execution snapshot.

The snapshot is returned raw — no config migrations are applied — so it reflects the workflow exactly as it existed when the run started, even if the underlying workflow has since been edited.

metaobject

Errors

422
Unprocessable Entity Error