async jobs

Submit an async explain job

Changed on

Queues a explain job and returns immediately with its job_id. The job runs in a sandbox; poll GET /v2/explain/jobs/{job_id} for its state and result. Accepts the same body as the synchronous endpoint plus an optional job_options.

post/v2/explain/async

Request

  • Base URL: https://api.nixtla.io
  • URL: https://api.nixtla.io/v2/explain/async
  • Auth: HTTP bearer

Request body

method'granger' | 'transfer_entropy'

Model-agnostic causal analysis method used by the /v2/explain endpoint. Options are: 'granger' (default) and 'transfer_entropy'.

Response

Successful Response

job_idstring required

Identifier for the accepted job. Prefixed per task (e.g. fc- for forecast).

Example response

{
  "job_id": "fc-4f2a1c9e8b7d4a6f9c3e1b5d7a9f2c4e"
}

Changes