Create a scoped key in Build → Developers with the applicable Submit forecasts and Read forecasts permissions. Send
Authorization: Bearer <key>. The forecasting REST selector is the workspace_id query parameter; conversation APIs have their own workspace selectors.
Request
Send theForecastRequestSchema body with a stable Idempotency-Key. Its method defaults to auto and its source.type selects numerical or metric. The generated OpenAPI reference describes the input schema and endpoints.
Numerical input supplies an interval, timezone, history start, horizon, and aligned target series. Metric input supplies the discovered metric and object type, history window, interval, horizon, and optional dimensions, filters, and declared companion inputs.
Response
Submission returnsrun_id, status, the retained price, and results_url. Draft, queued, and running submissions return HTTP 202; other returned states use HTTP 200.
Read responses contain run_id, status, method, method_version, rows, and next_cursor. Before completion, rows are empty because the run is still processing. A failed run returns error: "forecast_failed".
Completed rows include series/dimensions, interval bounds, operational point, available interval bounds, and selected quantiles with their interpretation metadata. The default read page is 50 rows with P05, P50, and P95. Available uncertainty depends on the method and result.
Errors
REST errors use
{"error":"code"}; unavailable service responses also include retryable: true. MCP has its own structured tool-error envelope. See the task guide for a complete synthetic request and pricing for current forecasting charges.