Klineo/Docs
Open app ↗

API schemas

AllocationPlan

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
allocatorVersion Yes Constant multi-venue-pareto-v1 —
intentName Yes string —
assetMappingId Yes string —
evaluatedAt Yes string Format: date-time
totalCapitalQuote Yes AtomicAmount —
reservedCapitalQuote Yes AtomicAmount —
deployableCapitalQuote Yes AtomicAmount —
selectedCandidateId Yes string —
allocations Yes Array of VenueAllocation —
paretoFrontier Yes Array of AllocationPlanCandidate —
alternatives Yes Array of AllocationPlanCandidate —
currentPlanScorePips Yes Pips —
expectedPlanScorePips Yes Pips —
expectedScoreImprovementPips Yes integer —
confidencePips Yes Pips —
excludedVenues Yes Array of object —
excludedVenues[].venueId Yes string —
excludedVenues[].reasonCodes Yes Array of string —
excludedVenues[].observedProfileStatus No OperatingSystemRecordStatus —
excludedVenues[].profileResourceVersion No Hash —
excludedVenues[].profileArtifactHash No Hash —
assumptions Yes Array of string —
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/AllocationPlan in the OpenAPI contract.