Skip to main content
POST
Run selected rows

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for an on-demand recompute run over rows: two scopes, one body.

Send record_ids to run a checkbox selection. Send all: true to run every row the current listing matches, optionally narrowed by where / row_status, exactly the predicate vocabulary of the rows query, so "run everything matching my filters" and "show me everything matching my filters" can never disagree about what matches. The explicit flag exists so an accidentally empty body runs nothing.

all
boolean
default:false

Run every matching row rather than a named set. Required (and only honoured) when record_ids is absent. At most view_scope_max_rows rows may match; a wider listing is refused with scope_too_large.

record_ids
string<uuid>[] | null

Record IDs of the rows to recompute.

Required array length: 1 - 1000 elements
row_status
enum<string> | null

Narrow an all run to errored or fully computed rows.

Available options:
errored,
fully_computed
where
TableRowsWhereSchema · object | null

Narrow an all run to rows matching this predicate tree.

Response

Successful Response

Result of requesting a row-scoped recompute run.

run is None while the workflow start is still queued. The run row is minted post-commit, and the active-runs poll picks it up.

run
TableRunReadSchema · object | null
required

A table recompute run with its static denominator and monotone counters.

request_id
string<uuid> | null

The id of this run request. The run is minted with it as its origin, so it is known at once, even while run is still null.