Task

Get task data or status

include_partial: while a bulk run is still going, return the rows that have already finished. Off by default — it turns every poll into a full read of the result hash, which a client polling every few minutes pays for and rarely wants.

include_trace: for a flow task, also return what each step of the run did — which node ran, what it produced, why it stopped, what it cost. Off by default, so the response is unchanged for callers that don't ask. Use it when a run comes back completed with nothing in data: the trace says whether every step missed, a condition halted the run, or a provider errored. Other task types return no trace. For a bulk flow task trace is a list aligned to the inputs, like data — a list or nothing, never a single run.

Results expire after 24 hours and the poll then answers 410. The record of the run is kept, though, so with include_trace that 410 still carries the trace.

get/external/v1/tasks/{task_id}

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

Query parameters

include_partialboolean
include_traceboolean

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.