v6

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01485121699.8 KB

Get Predictions

Evaluate all predictive forecasts and return active alerts.

Checks three forecast dimensions:

  • Budget exhaustion: At current spend velocity, when will the budget cap be reached?
  • Completion rate decline: Is the task completion rate trending downward, indicating the run will take longer than expected?
  • Run duration overrun: Based on current throughput, will the run exceed the configured time window?

Use budget_cap to enable the budget forecast. The run duration forecast requires at least one completed task.

Returns a list of alerts ordered by severity (critical first). Each alert has: kind, severity, message, minutes_until_impact, confidence.

get/metrics/predictions

Query parameters

budget_capnumber

Budget ceiling in USD (0 = skip budget forecast)

Budget ceiling in USD (0 = skip budget forecast)

window_hoursnumber

Configured run window in hours (default 4)

Configured run window in hours (default 4)

Response

Successful Response

{"stackTrail":"paths:/metrics/predictions:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}