API Reference
Trigger procedures, track runs, handle human reviews, and configure webhooks — all via REST.
Two APIs
Rapidfolio exposes two REST APIs:
| API | Base URL | What it's for |
|---|---|---|
| Runner API | https://run.rapidfolio.com | Start runs, check status, submit review decisions |
| Dashboard API | https://app.rapid.io/api/v1 | Manage API keys, webhooks, and workspace settings |
All requests require an API key in the Authorization: Bearer header.
Common tasks
Start a procedure from your backend:
Call POST /v1/procedures/:id/:environment on the Runner API. Choose async (get back a runId immediately) or sync (wait for the result inline).
→ Run a Procedure
Track the result:
Poll GET /runs/:runId until the status is completed, failed, or cancelled — or subscribe to webhooks instead.
→ Manage Runs
Get alerted when something needs review:
Subscribe to human_review_requested and get a signed webhook the moment a run pauses for human approval.
→ Webhooks
Submit an approval decision:
POST /runner-proxy/review/:runId with approved: true or false and an idempotency key.
→ Human Review API
Create or rotate API keys: Manage keys programmatically via the Dashboard API. → API Keys
Environments
The API key you use determines whether a run is sandbox or live. There's no separate environment parameter — the key prefix says it all:
| Prefix | Environment |
|---|---|
rsk_sandbox_ | Sandbox |
rsk_live_ | Live |