table-rows

Estimate the credit cost of a row run

Estimate the credit cost of a row run without running it. Takes the same request body as the run endpoint (a named selection, or every row the current listing matches), so estimate and run can never disagree about scope.

post/tables/{table_id}/rows/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}/rows/run/estimate/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required

Request body

allboolean

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_idsstring[] nullable

Record IDs of the rows to recompute.

row_status'errored' | 'fully_computed'

A row-level state, derived from its cells rather than stored.

ERRORED is "any cell of this row failed to compute"; FULLY_COMPUTED is its exact complement, so the two partition the table. Serves the built-in smart views, which are questions about computation rather than about values. The ordinary filter vocabulary cannot express either.

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.