table-columns

Estimate the credit cost of a multi-column run

Estimate the credit cost of a bundled cell run without running it. Takes the same request body as the run endpoint so estimate and run can never disagree about scope. A column another named column feeds is counted once, which is why summing the per-column estimates gives a larger number.

post/tables/{table_id}/columns/run/estimate/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/columns/run/estimate/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required

Request body

column_idsstring[] required

The computed columns to run, in any order. A column another one here feeds is planned once, AFTER its input, so no column reads a value a sibling is still computing. Sending one request per column instead is what makes them race.

record_idsstring[] required

The target rows, shared by every column named. A swept selection is a rectangle. Duplicates are dropped and the order is kept.

Response

Successful Response

balance_sufficientboolean required

Whether the organization's available credits cover the estimate.

cells_totalinteger required

All cells the run would compute, charged or not.

estimated_creditsnumber required

The most the run can cost, in credits: every row of every paid column charged its full per-row price. What the credit hold and the confirmation gate reason about.

expected_creditsnumber

What a run like this usually costs, in credits: a column charged by use (an AI column) at the share of its per-row maximum the same kind of cell has actually been charged (a typical share while there is no history yet), every other column at its price. Quote both: up to estimated_credits, usually about expected_credits. Equal to estimated_credits for a flat price (no column charged by use, as in a run of enrichments): then quote that one figure, without up to.

is_estimateboolean required

Always true: freshness and row counts can shift by run time.

requires_confirmationboolean

True when the estimate crosses the confirmation threshold: ask before spending instead of running on first click.

rows_held_backinteger

Rows in scope the column's run condition would hold back. Already subtracted from rows_in_scope.

rows_in_scopeinteger

Rows the run would cover. This is what a scope choice is about, and what the credit estimate is derived from; cells_total also counts the dependent columns the run would recompute.

scope_too_largeboolean

True when the filtered view names more rows than a run may be scoped to (view_scope_max_rows). rows_in_scope still carries the matching count; the run itself would be refused with scope_too_large. Narrow the filter, or run the whole table.

unit_pricenumber required

Blended credits per charged cell (total estimate / units); 0 for free runs.

unitsinteger required

Cells that would incur a charge (0 for free runs).

Changes

No recorded changes to this operation across all 1 revision of this API.