Skip to content

Get Capacity Forecast

GET
/api/v1/monitoring/capacity/forecast
curl --request GET \
--url 'https://api.ultimateteam.ai/api/v1/monitoring/capacity/forecast?service=example&horizon_days=7' \
--header 'X-API-Key: <X-API-Key>'

Return the latest capacity forecast for a service.

Forecasts are cached in Redis by the weekly cadence worker (Monday 6 AM UTC) with an 8-day TTL.

Args: service: Cloud Run service name. horizon_days: Forecast horizon (1-30 days). user: Authenticated user context.

Returns: Cached capacity forecast data.

Raises: HTTPException 404: No forecast available yet.

service
required
Service

Cloud Run service: api, worker, app_frontend, or marketing

string

Cloud Run service: api, worker, app_frontend, or marketing

horizon_days
Horizon Days

Forecast horizon in days

integer
default: 7 >= 1 <= 30

Forecast horizon in days

Successful Response

Media typeapplication/json
CapacityForecastDTO

Cached capacity forecast for a Cloud Run service.

object
confidence_score
required
Confidence Score
number
data_sources
required
Data Sources
Array<string>
expected_outcome
required
Expected Outcome
object
key
additional properties
number
generated_at
required
Generated At
string
horizon_days
required
Horizon Days
integer
p95_instances
required
P95 Instances
number
peak_instances
required
Peak Instances
number
projected_cost_monthly_usd
required
Projected Cost Monthly Usd
number
projected_utilization
required
Projected Utilization
number
reasoning_chain
required
Reasoning Chain
Array<string>
service
required
Service
string
Examplegenerated
{
"confidence_score": 1,
"data_sources": [
"example"
],
"expected_outcome": {
"additionalProperty": 1
},
"generated_at": "example",
"horizon_days": 1,
"p95_instances": 1,
"peak_instances": 1,
"projected_cost_monthly_usd": 1,
"projected_utilization": 1,
"reasoning_chain": [
"example"
],
"service": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}