Skip to main content
POST
Run a formula column

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id
string<uuid>
required
column_id
string<uuid>
required

Body

application/json

Scope for an on-demand recompute of one formula column.

scope
enum<string>
required

Row scope: all | errored | unfilled | first_n | cell.

Available options:
all,
errored,
unfilled,
first_n,
cell
limit
integer | null

Row count for scope=first_n (default 10).

Required range: 1 <= x <= 10000
offset
integer | null

Starting-row offset in display order for scope=first_n; omit to start at the first row.

Required range: 0 <= x <= 1000000
record_id
string<uuid> | null

The target row for scope=cell; see also record_ids.

record_ids
string<uuid>[] | null

The target rows for scope=cell — a swept selection re-runs in one request rather than one per cell. Wins over record_id when both are sent; scope=cell requires at least one of the two.

Maximum array length: 1000

Response

Successful Response

Result of requesting an on-demand column run.

run is None when the workflow start is still queued (the run row is minted post-commit) — the frontend's 2-second active-runs poll picks it up.

run
TableRunReadSchema · object | null
required

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