v4

latestOpenAPI 3.1.02026-08-08278476614.0 KB

import

Cancel Import Job

Ask a running import to stop at its next chunk boundary.

Cooperative, never a DBOS hard cancel: the workflow observes the flag and falls through to its normal finalize, so the rows that already resolved are still committed. A hard cancel would skip that finalize entirely.

409 when the job already moved — a lost claim is an answer, not a retry.

post/api/v1/import/jobs/{job_id}/cancel

Path parameters

job_idstring uuid required

Response

Successful Response

idstring uuid required

project_idstring uuid required

status'pending' | 'running' | 'cancelling' | 'completed' | 'failed'

Lifecycle of one background import.

PENDING: row inserted, workflow enqueued, no chunk resolved yet
RUNNING: the workflow claimed the job and is resolving chunks
CANCELLING: the user asked to stop; the workflow observes this at the next chunk boundary and falls through to a normal finalize. Cancel is cooperative, so this is an in-flight state, not a terminal one — the partial commit still has to happen.
COMPLETED: finalized, whether every row resolved or only some
FAILED: finalized with nothing committed, or the workflow raised

total_rowsinteger

resolved_rowsinteger

committed_rowsinteger

shortfall_rowsinteger

failure_reasonstring nullable

created_atstring date-time nullable

updated_atstring date-time nullable