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 Status

GET
/api/v1/workflows/:workflow_id/runs/:run_id/status
GET
/api/v1/workflows/:workflow_id/runs/:run_id/status
$curl https://api.onepin.ai/api/v1/workflows/workflow_id/runs/run_id/status \
> -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": "running",
6 "run_number": 42,
7 "token_cost": 350,
8 "created_at": "2024-04-20T14:20:00Z",
9 "updated_at": "2024-04-20T14:25:00Z",
10 "total_nodes": 15,
11 "total_steps": 120,
12 "finished_steps": 45,
13 "usage_summary": {
14 "cpu_seconds": 12.5,
15 "memory_mb": 256,
16 "api_calls": 8
17 },
18 "started_at": "2024-04-20T14:22:00Z",
19 "completed_at": null,
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 },
27 "meta": {
28 "request_id": "req_1234567890abcdef",
29 "timestamp": "2024-04-20T14:25:01Z"
30 }
31}

Lightweight run status for polling.

Returns only the volatile run state (status, step counts, timestamps, usage_summary, error, has_export) — no graph snapshot. Use this for progress polling; call GET /runs/{run_id} once to load the immutable definition snapshot.

Was this page helpful?
Previous

Cancel Run

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

workflow_idstringRequiredformat: "uuid"
run_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error