onepin workflows

Manage workflows in your workspace. Requires a key with workflows:read (list/show/runs) or workflows:run (run) scope.

list

Synopsis

onepin workflows list [OPTIONS]

Flags

Examples

$
# List first 50 workflows (table)
$
onepin workflows list
$
$
# All workflows, JSON — pipe to jq
$
onepin workflows list --all --json | jq '.[] | {id, name}'
$
$
# Second page
$
onepin workflows list --offset 50 --limit 50

Output (table)

ID                                    NAME                 STATUS    UPDATED
3fa85f64-5717-4562-b3fc-2c963f66afa6  My first workflow    active    2026-05-01
7d8e9f00-1234-5678-abcd-ef0123456789  Production TTS       active    2026-04-28

show

Synopsis

onepin workflows show <WORKFLOW_ID>

Description

Retrieves a single workflow by UUID, including its full definition (graph and execution config).

Examples

$
onepin workflows show 3fa85f64-5717-4562-b3fc-2c963f66afa6
$
$
# JSON — extract definition
$
onepin workflows show 3fa85f64-5717-4562-b3fc-2c963f66afa6 --json | jq '.definition'

Errors

run

Synopsis

onepin workflows run <WORKFLOW_ID> [--watch] [--json]

Description

Triggers an execution run of the workflow. The workflow definition encodes all input parameters — no request body is sent.

With --watch, the CLI polls the run status until it reaches a terminal state (completed, failed, or cancelled):

• Initial poll interval: 2 s
• Backoff: interval = min(interval × 2, 30) after each non-terminal response
• Jitter: ±20% applied per poll to avoid thundering herd
• 429 responses: the Retry-After header value is used instead of the computed interval
• Ctrl+C: sends a cancel request for the run, then exits 130

Flags

Examples

$
# Fire and forget
$
onepin workflows run 3fa85f64-5717-4562-b3fc-2c963f66afa6
$
# Run started: run_01JXXXXXXXXXXXXXXXXXXXXX
$
$
# Watch until done
$
onepin workflows run 3fa85f64-5717-4562-b3fc-2c963f66afa6 --watch
$
# Run started: run_01JXXXXXXXXXXXXXXXXXXXXX
$
# ● running  (5s)
$
# ● running  (11s)
$
# ✓ completed  (23s)
$
$
# JSON output (useful in CI)
$
onepin workflows run 3fa85f64-5717-4562-b3fc-2c963f66afa6 --json

1
{
2
  "id": "run_01JXXXXXXXXXXXXXXXXXXXXX",
3
  "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
  "status": "running",
5
  "created_at": "2026-05-27T09:00:00Z"
6
}

Exit codes

Errors

runs

Synopsis

onepin workflows runs <WORKFLOW_ID> [OPTIONS]

Description

Lists the run history for a workflow, most recent first.

Flags

Examples

$
onepin workflows runs 3fa85f64-5717-4562-b3fc-2c963f66afa6
$
$
# JSON — extract IDs and statuses
$
onepin workflows runs 3fa85f64-5717-4562-b3fc-2c963f66afa6 --json | jq '.[] | {id, status}'

Output (table)

RUN ID                             STATUS     CREATED
run_01JXXXXXXXXXXXXXXXXXXXXX       completed  2026-05-27 09:00
run_01JWWWWWWWWWWWWWWWWWWWW       failed     2026-05-26 14:33