Quickstart

Get from zero to a running workflow in under 5 minutes.

1. Install

$
pip install onepin

Python 3.10 or later required. The package includes both the onepin Python library and the onepin CLI entry point.

2. Get an API key

Sign in at app.onepin.ai/settings/api-keys, create a key, and copy the value. Keys are prefixed op_live_.

3. Authenticate

$
onepin login
$
# Paste your key when prompted

4. List your workflows

$
onepin workflows list

5. Start a workflow run

$
onepin workflows run 3fa85f64-5717-4562-b3fc-2c963f66afa6

6. Watch run progress

$
onepin workflows run 3fa85f64-5717-4562-b3fc-2c963f66afa6 --watch

Next steps

• Authentication — full scope table, credential file format, key rotation
• Python SDK — Usage — all resources, pagination, async, error handling
• CLI — Overview — complete command reference and global flags