table-runs

Cancel a table run

Request cancellation of one active run: the run flips to cancelling, its running pages observe the flip within about a second (answers already in the table stay; a cell still computing is dropped uncharged), and the workflow finalizes the run as cancelled. Edge case: a cancel accepted after the final page has already computed finalizes the run as completed (or completed_with_errors) instead of cancelled.

post/tables/{table_id}/runs/{run_id}/cancel/

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}/runs/{run_id}/cancel/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required
run_idstring uuid required

Response

Successful Response

cells_awaitinginteger required

Cells the run held because an input they read has not been computed yet. Not a final state: a later run fills them. Counted within cells_done.

cells_doneinteger required

Cells processed so far; clamped to cells_total so the banner can never overshoot.

cells_failedinteger required

Cells whose formula evaluation failed.

cells_no_datainteger required

Cells that ran clean but found nothing. Never retried, and excluded from errored views. Free for a lookup; an AI column's cell is charged what it used. Counted within cells_done.

cells_skippedinteger required

Cells the run deliberately skipped: a missing required input or a false run condition. Counted within cells_done.

cells_totalinteger required

Exact static denominator, fixed when the run plan is minted.

column_idstring uuid nullable

The column a column-lineage run recomputes, parsed from its workflow identity; null for whole-table runs. Narrows the grid's busy paint to one column; row_scope is what narrows it to the rows within that column.

column_idsstring[] nullable

Every column this run's plan covers, in dependency (layer) order, not the order they were requested in. Null on runs minted before the plan was published, where column_id is all there is. This is what narrows the grid's busy paint when one run covers several columns, which column_id cannot express.

completed_atstring date-time nullable required
created_atstring date-time required
credits_chargednumber

Credits charged so far. Grows while the run works, as its finished cells are settled every few seconds; final once the run ends.

errorstring nullable required

Failure description when the run status is failed.

export_retry_attemptinteger

How many automatic export retries preceded this run. 0 is a run a person or a schedule asked for; higher values mark the follow-ups queued for rows whose push failed for a retryable reason, so a run history can tell 'we tried again' from 'you ran it again'.

idstring uuid required
started_atstring date-time nullable required
status'pending' | 'running' | 'cancelling' | 'cancelled' | 'paused_for_credits' | 'completed' | 'completed_with_errors' | 'failed' required

Lifecycle status of a table run.

PENDING exists for API compatibility but is never observed: runs are born RUNNING at mint. CANCELLING is the requested-stop state the page activities observe; the workflow finalizes it to CANCELLED.

table_idstring uuid required
trigger'cell_edited' | 'row_added' | 'row_manual' | 'column_added' | 'column_edited' | 'column_manual' required

What kind of mutation requested a recompute run.

Changes

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