Develop
REST API
Start a run with one HTTP request. Covers authentication, the request body and the response.
The REST API starts workflow runs over HTTP. The Node SDK is a wrapper around it.
Authentication
Send your secret key as a bearer token.
Authorization: Bearer $FLOWBLOCKS_SECRET_KEYStart a run
curl https://api.flowblocks.dev/v1/runs \
-H "Authorization: Bearer $FLOWBLOCKS_SECRET_KEY" \
-d '{
"workflow": "support-triage",
"input": "Where is my refund for order 1042?",
"max_steps": 20
}'Body
Prop
Type
Response
{
"run_id": "run_01J9X4T2V8KQ3M6ZB7C5N0RDHF",
"workflow": "support-triage",
"status": "completed",
"steps": 6,
"approvals": 1,
"duration_s": 3.2,
"run_url": "https://app.flowblocks.dev/runs/01J9X4T2"
}| Field | Meaning |
|---|---|
run_id | The run's identifier |
workflow | The workflow that ran |
status | How the run ended |
steps | How many step visits the run made |
approvals | How many approvals it waited for |
duration_s | How long it took, in seconds |
run_url | The run's full record, step by step |