Klineo/Docs
Open app ↗

API schemas

AllocationPlanCandidate

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
candidateId Yes string —
objective Yes string Allowed: BALANCED, EXECUTION_QUALITY, CAPITAL_EFFICIENCY, RISK_MINIMIZED, EXIT_FLEXIBILITY
allocations Yes Array of VenueAllocation —
scoreVector Yes AllocationScoreVector —
aggregateScorePips Yes Pips —
confidencePips Yes Pips —
executionClass Yes string Allowed: PREVIEW_ONLY, BDEX_TYPED_EXECUTABLE

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/AllocationPlanCandidate in the OpenAPI contract.