Task

Cancel a running task

Stop a running task and refund what its unfinished requests had reserved.

Rows that already finished keep their results: poll the task afterwards to collect them.

post/external/v1/tasks/{task_id}/cancel

Request

  • Base URL
    https://api.databar.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-apikey

Path parameters

task_idstring required

Response

OK

task_idstring required

Unique identifier of the task.

request_idstring nullable

Deprecated: use task_id instead. Same value as task_id.

statusstring required

Current status: 'processing', 'completed', 'failed', or 'cancelled'.

progressobject nullable

How far a bulk run has got: total, completed, no_data, failed and processing counts of inputs. no_data is a clean miss. failed is a real error on that input. Omitted for single (non-bulk) runs.

inputobject nullable

Echo of the submitted inputs, aligned to data so you can attribute results back to what was searched. Shape mirrors the run body: {"params": {...}} for a single run and {"params": [{...}, ...]} for a bulk run, where params[i] corresponds to data[i] (same order, misses included). Omitted for waterfall tasks and for flow tasks whose input echo has expired.

credits_spentnumber

Changes

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