v2

latestOpenAPI 3.0.32026-07-26112274.7 KB

Poll forecast job status and artifact list

Returns the current status and artifact metadata for a forecast job you own. Poll this endpoint until status is completed or failed. Once completed, download output files via GET /api/v1/forecasts/{id}/artifacts/{name}.

Jobs tombstoned by the retention policy return 404.

get/api/v1/forecasts/{id}

Path parameters

idstring uuid required

Forecast job id returned by POST /api/v1/forecasts.

Response

Job status and artifact metadata.

job_idstring uuid

pipeline_errorobject nullable

Structured error from the pipeline for failed or canceled jobs; null otherwise. Common fields: code (string error code) and detail (human-readable explanation). Shape is defined by the pipeline and may vary.

settledboolean

True once the job has reached a terminal state and the charge has been posted.

status'queued' | 'running' | 'completed' | 'failed' | 'canceled'

Current lifecycle state of the job.

Example response

{
  "artifacts": [
    {
      "name": "forecast.json",
      "href": "/api/v1/forecasts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/artifacts/forecast.json",
      "content_type": "application/json",
      "size": 4096
    }
  ]
}