Skip to content
POST/api/v1/health/planning-horizon/async

Planning Horizon (Async)

Submit planning horizon analysis as async job.

Request example

json
json
{
  "tasks": [
    {
      "id": "T1",
      "duration_days": 5
    }
  ]
}

Request fields from OpenAPI contract

Required fields and the optional fields that change this call are listed here. The shared task model stays on the task schema guide.

This table is generated from the endpoint schema in openapi.json.

FieldTypeRequiredDescription
tasksarray<unknown>RequiredSchedule tasks.
tasks[].idstringRequiredUnique task identifier
status_datestring | nullOptionalCurrent data date (ISO 8601, e.g. '2026-03-17'). When omitted, today's date is used as the planning horizon anchor.
schedule_historyarray<object> | nullOptionalNo description in OpenAPI contract.
optionsobjectOptionalOptions controlling planning horizon analysis.
options.horizon_bandsarray<unknown>OptionalNo description in OpenAPI contract.
options.horizon_bands[].namestringOptionalNo description in OpenAPI contract.
options.horizon_bands[].daysintegerOptionalNo description in OpenAPI contract.
options.readiness_dimensionsarray<string>OptionalNo description in OpenAPI contract.
options.day_typestringOptionalNo description in OpenAPI contract.
options.include_risk_rankingbooleanOptionalNo description in OpenAPI contract.
options.include_recommendationsbooleanOptionalNo description in OpenAPI contract.
options.min_float_daysintegerOptionalNo description in OpenAPI contract.
options.max_forecast_drift_daysintegerOptionalNo description in OpenAPI contract.

Response example

json
json
{
  "score": 92,
  "grade": "A"
}

Schema

json-schema
{
  "$ref": "#/components/schemas/PlanningHorizonRequest"
}

Authentication

  • x-api-key header

Reference details

Operation ID
health_planning_horizon_async
Section
health
Tags
health
Playground link
/playground?endpoint=%2Fapi%2Fv1%2Fhealth%2Fplanning-horizon%2Fasync&method=post

Was this page helpful?

Your feedback helps us improve docs, reference pages, and Playground flows.

Topic: Planning Horizon (Async) · Page: /docs/api-reference/health_planning_horizon_async

TermsPrivacyContact

Schedule analysis guidance. Not legal advice. You remain responsible for contract and agency compliance.