Forecasts

POST /v1/forecast

Generate a Monte-Carlo forecast on demand. Scope: forecast:write. Team and above (Team capped at 100/mo, $0.25 per generation on Team; included on Enterprise). subject takes an object (entity_id, program, …) or a plain string, which is treated as a program name. m_and_a_probability needs a resolvable entity — use the object form with an entity_id from GET /v1/entities/search.

bash

# Resolve the entity first
curl "https://api.forumatlas.com/v1/entities/search?q=<entity+name>" \
  -H "Authorization: Bearer $FORUM_API_KEY"

# Then forecast with the object-form subject
curl "https://api.forumatlas.com/v1/forecast" \
  -H "Authorization: Bearer $FORUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "forecast_type": "m_and_a_probability", "subject": { "entity_id": "<entity_id>" }, "horizon_days": 365 }'

GET /v1/forecasts

List forecasts in your workspace. Scope: forecast:read.

GET /v1/forecasts/{id}

Full distribution + drivers + revision history. Response shape (abridged — full schema in the OpenAPI spec):

json

{
  "forecast_id": "ffd5b7bd-...",
  "title": "<subject> — <forecast type>, <horizon>",
  "point_estimate": <float 0-1>,
  "confidence_interval": [<float>, <float>],
  "distribution": [{ "lower": 0, "upper": 0.05, "probability": 0.001 }],
  "drivers": [],
  "revisions": []
}