Skip to main content

V2RecommendationRequest

Body for POST /v2/recommendations (compute on demand).

Field-compatible with Sarucci's internal RL run request so partners and internal callers share the same vocabulary.

company_iduuidrequired

Company to compute recommendations for.

business_date object

Anchor date for the run. Defaults to today (server clock) when omitted. The horizon extends forward from this date.

anyOf
date
horizon_daysHorizon Days

How many days forward from business_date to return. The run itself always prices the full served calendar — each model at its own horizon — so this narrows the response rather than the work, and asking for fewer days does not make the call cheaper.

Possible values: >= 1 and <= 365

Default value: 365
dry_runDry Run

When true, the run is computed but not persisted (no row in rl_pricing_run). Use for sandboxing — GET /v2/recommendations won't see dry-run results.

Default value: false
V2RecommendationRequest
{
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "business_date": "2024-07-29",
  "horizon_days": 365,
  "dry_run": false
}