Run a routine

Starts a run of the active version (or `version`) with `input`, validated against the routine's `inputs` schema. Use `?wait=` for tool-call style use (an `ephemeral` run that finishes within the wait never touches the journal), `Accept: text/event-stream` to follow steps live, or `webhook`. Effect steps without a product meter of their own bill `routines.effect_step`; product steps bill their product's unit.

POST /v1/routines/{routine}/runs
Starts a run of the active version (or `version`) with `input`, validated against the routine's `inputs` schema. Use `?wait=` for tool-call style use (an `ephemeral` run that finishes within the wait never touches the journal), `Accept: text/event-stream` to follow steps live, or `webhook`. Effect steps without a product meter of their own bill `routines.effect_step`; product steps bill their product's unit.

Authentication

Bearer Token (b3os_sk_ API key or b3os_pat_ token) API Key (cookie: __Host-b3os_session)

Path Parameters

routine string required path
A routine ID (`rtn_…`) or name. Names are unique per project; `runs`, `hooks`, `validate` and `import` are reserved and cannot be routine names.
Example: "nightly-digest"

Query Parameters

wait integer optional query
Seconds to wait for the job to finish before responding, from 0 to 60. If it finishes in time the response is `200` with the finished job; otherwise `202` with the job as it is, a `Location` to poll and `Retry-After`. `0` (the default) returns immediately.

Header Parameters

Idempotency-Key string optional header
A unique value (for example a UUID) that makes this request safe to retry. Scoped to your project for 24 hours: a retry with the same key, method, path and body returns the stored response with `Idempotent-Replayed: true`, and only to the same API key. Reusing the key for a different request returns `409 idempotency_key_conflict`.

Request Body

application/json
input object
Validated against the routine's `inputs`; defaults from it are applied.
version string | integer
Run this version instead of the active one (`ver_` ID or number).
One of:
Option 1string
Option 2integer
durability string
Override the routine's default durability for this run.
Enum: ephemeral, standard, strict
webhook object
Where to deliver this job's events. Deliveries are `POST`s of a `WebhookEvent` signed with `B3OS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">` using the endpoint's secret (`POST /v1/webhooks/secret`). Failed deliveries are retried with backoff for 24 hours. Delivery goes through the egress guard, so private and loopback addresses are refused.
url string (uri) REQUIRED
An `https://` URL.
events string[]
Event types to deliver. Defaults to the terminal events (`job.succeeded`, `job.failed`, `job.canceled`); `["*"]` delivers every event.
Array of: string
metadata object
Up to 16 string key-value pairs you attach to an object for your own use. Keys are 1 to 40 characters of `A-Z a-z 0-9 _ . : -`; values are at most 500 characters. B3OS never interprets them.

Responses

200 The run finished within `wait` seconds, or the event stream when `Accept` is `text/event-stream`.
application/json
id string REQUIRED
object string REQUIRED
Enum: routine_run
status string REQUIRED
`queued` → `running` → one of the terminal statuses `succeeded`, `failed` or `canceled`. A job never leaves a terminal status.
Enum: queued, running, succeeded, failed, canceled
created_at string (date-time) REQUIRED
updated_at string (date-time) REQUIRED
started_at string (date-time) | null
finished_at string (date-time) | null
progress object
How far a job has got, in the job's own unit (pages, items, steps).
completed integer REQUIRED
Units finished, successfully or not.
failed integer
Units that failed (included in `completed`).
total integer | null
Units expected, when known.
unit string REQUIRED
What is counted, such as `pages`, `items` or `steps`.
result unknown
The job's output. Present once `status` is `succeeded`; the product's job type defines its shape.
error object
An RFC 9457 problem. `code` is stable and listed in the errors catalog; `type` links to its entry. `detail` is human-readable and may change. Extension members appear only for the codes that document them; ignore members you do not recognize.
type string (uri) REQUIRED
`https://docs.beta.b3os.org/errors#<code>`.
title string REQUIRED
Short summary of the problem type.
status integer REQUIRED
The HTTP status code, repeated for convenience.
code string REQUIRED
Stable machine-readable error code from the errors catalog.
detail string REQUIRED
Explanation of this occurrence. Never contains secrets.
instance string
The request ID (`req_…`) of the request that failed. Include it when you contact support.
errors object[]
Validation problems, one per field (`invalid_request` and the other codes that list `errors`).
Array of:
pointer string REQUIRED
Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.
detail string REQUIRED
What is wrong there.
reason string
Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).
required_scope string
The scope that was missing (`forbidden` with `reason: scope`).
retry_after_s integer
Same value as the `Retry-After` header, for clients that only read the body.
limit object
The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.
id string REQUIRED
Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.
limit number REQUIRED
The limit's value.
unit string REQUIRED
What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.
window_s integer
Window length in seconds for rate limits and quotas.
current number
Current usage against the limit, when known.
current_status string
The object's current status, for state conflicts such as `sandbox_not_running`.
upstream_status integer
The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).
step string
The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).
pack_error object
The error a pack's error mapping chose (`upstream_error` from pack actions).
code string REQUIRED
message string REQUIRED
retryable boolean REQUIRED
timing object
Server-side phase durations in milliseconds with microsecond resolution: the same phases as the `Server-Timing` header, keyed `<phase>_ms`. `total_ms` is always present. Phase names are product-specific and documented per operation. Example values in this reference are illustrative, not measurements.
total_ms number REQUIRED
expires_at string (date-time) | null
When the job's results are deleted (retention); `null` while the job is not terminal.
metadata object
Up to 16 string key-value pairs you attach to an object for your own use. Keys are 1 to 40 characters of `A-Z a-z 0-9 _ . : -`; values are at most 500 characters. B3OS never interprets them.
webhook object
Where to deliver this job's events. Deliveries are `POST`s of a `WebhookEvent` signed with `B3OS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">` using the endpoint's secret (`POST /v1/webhooks/secret`). Failed deliveries are retried with backoff for 24 hours. Delivery goes through the egress guard, so private and loopback addresses are refused.
url string (uri) REQUIRED
An `https://` URL.
events string[]
Event types to deliver. Defaults to the terminal events (`job.succeeded`, `job.failed`, `job.canceled`); `["*"]` delivers every event.
Array of: string
routine_id string REQUIRED
version_id string REQUIRED
version_number integer REQUIRED
durability string REQUIRED
Enum: ephemeral, standard, strict
trigger object REQUIRED
How the run started (the `trigger` context of its expressions).
type string REQUIRED
Enum: api, cron, interval, webhook, action, routine
id string
The trigger ID (cron, interval, webhook, action).
occurrence_id string
Cron and interval occurrence, used to deduplicate fires.
scheduled_at string (date-time)
hook_id string
delivery_id string
subscription_id string
The trigger subscription that delivered the event (action triggers).
event_id string
The pack trigger event's ID (action triggers).
parent_run_id string
For sub-routine runs.
parent_step_id string
input object REQUIRED
steps object[] REQUIRED
Top-level steps in definition order.
Array of:
id string REQUIRED
The step ID from the definition.
uses string
item_index integer
Position in the map's list, for steps inside a map body.
status string REQUIRED
Enum: pending, running, waiting, retrying, succeeded, failed, skipped, canceled
attempt integer REQUIRED
started_at string (date-time)
finished_at string (date-time)
duration_ms number
outputs unknown
The step's outputs, once it succeeded.
error object
An RFC 9457 problem. `code` is stable and listed in the errors catalog; `type` links to its entry. `detail` is human-readable and may change. Extension members appear only for the codes that document them; ignore members you do not recognize.
type string (uri) REQUIRED
`https://docs.beta.b3os.org/errors#<code>`.
title string REQUIRED
Short summary of the problem type.
status integer REQUIRED
The HTTP status code, repeated for convenience.
code string REQUIRED
Stable machine-readable error code from the errors catalog.
detail string REQUIRED
Explanation of this occurrence. Never contains secrets.
instance string
The request ID (`req_…`) of the request that failed. Include it when you contact support.
errors object[]
Validation problems, one per field (`invalid_request` and the other codes that list `errors`).
Array of:
pointer string REQUIRED
Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.
detail string REQUIRED
What is wrong there.
reason string
Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).
required_scope string
The scope that was missing (`forbidden` with `reason: scope`).
retry_after_s integer
Same value as the `Retry-After` header, for clients that only read the body.
limit object
The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.
id string REQUIRED
Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.
limit number REQUIRED
The limit's value.
unit string REQUIRED
What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.
window_s integer
Window length in seconds for rate limits and quotas.
current number
Current usage against the limit, when known.
current_status string
The object's current status, for state conflicts such as `sandbox_not_running`.
upstream_status integer
The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).
step string
The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).
pack_error object
The error a pack's error mapping chose (`upstream_error` from pack actions).
code string REQUIRED
message string REQUIRED
retryable boolean REQUIRED
map object
Item counts for a map step.
total integer
succeeded integer
failed integer
running integer
waiting_for object
What a waiting step waits for.
signal string
until string (date-time)
202 The run was accepted and is still running.
400 The request failed validation (`invalid_request`, `invalid_url`).
401 Missing, malformed, expired or revoked credentials (`unauthorized`).
402 The organization has no credits left, or the key reached its spend cap.
403 The key that published the active version is revoked (`run_as_revoked`).
404 No such routine in this project (`routine_not_found`).
409 The `Idempotency-Key` was used for a different request or by a different key (`idempotency_key_conflict`), or the run it started is still being accepted (`idempotency_request_in_progress`, with `Retry-After`).
413 The request body exceeds this operation's limit.
415 The Content-Type is not accepted by this operation.
422 `input` does not match the routine's `inputs` schema (`run_input_invalid`, with `errors`), or `webhook.url` is not an absolute `https://` URL of at most 2,048 characters (`invalid_webhook_url`).
429 A rate, concurrency or quota limit applies (`rate_limited`, `concurrency_limited`, `quota_exceeded`).
500 Something failed inside B3OS (`internal`). Retry with backoff.
503 The node or the product is not available right now (`node_unavailable`, `product_unavailable`, `capacity_unavailable`). 
curl -X POST 'https://beta-api.b3os.org/v1/routines/nightly-digest/runs' \  -H 'Authorization: Bearer YOUR_API_TOKEN' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "topic": "pricing"  },  "durability": "ephemeral"}'
const response = await fetch('https://beta-api.b3os.org/v1/routines/nightly-digest/runs', {  method: 'POST',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN",      "Content-Type": "application/json"  },  body: JSON.stringify({    "input": {      "topic": "pricing"    },    "durability": "ephemeral"  })});const data = await response.json();console.log(data);
import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.post('https://beta-api.b3os.org/v1/routines/nightly-digest/runs', headers=headers, json={  "input": {    "topic": "pricing"  },  "durability": "ephemeral"})print(response.json())
200 Response 
{  "id": "run_01m5t5fr06dx6azc42f4wbzf5s",  "object": "routine_run",  "status": "succeeded",  "routine_id": "rtn_01m5t6vhkw4a8fa4tb5w4ffz37",  "version_id": "ver_01m5t6ncrsssrysy1p2fbn2pgf",  "version_number": 2,  "durability": "ephemeral",  "trigger": {    "type": "api"  },  "input": {    "topic": "pricing"  },  "result": {    "summary": "Prices did not change today."  },  "steps": [    {      "id": "page",      "uses": "vision/scrape@1",      "status": "succeeded",      "attempt": 1,      "started_at": "2026-10-25T19:50:00.001Z",      "finished_at": "2026-10-25T19:50:00.092Z",      "duration_ms": 91.2    },    {      "id": "summary",      "uses": "infer/chat@1",      "status": "succeeded",      "attempt": 1,      "started_at": "2026-10-25T19:50:00.092Z",      "finished_at": "2026-10-25T19:50:01.310Z",      "duration_ms": 1218.4    }  ],  "progress": {    "completed": 2,    "total": 2,    "unit": "steps"  },  "created_at": "2026-10-25T19:50:00.000Z",  "updated_at": "2026-10-25T19:50:01.310Z",  "started_at": "2026-10-25T19:50:00.000Z",  "finished_at": "2026-10-25T19:50:01.310Z",  "timing": {    "dispatch_ms": 0.02,    "steps_ms": 1309.6,    "total_ms": 1310.1  },  "expires_at": "2026-11-24T19:50:01.310Z",  "metadata": {}}
Previous List a routine's runs
Next Get a run
Ask a question... ⌘I