Structure

AISessionPayload

The full structured payload returned by shipit ai-session.

struct AISessionPayload

Overview

This is a stable, versioned JSON contract for AI agent consumption. Check version before parsing to detect breaking changes.

let agentPrompt: String
A concise system prompt the host agent should include in its context.
let ambiguities: [AmbiguityFlag]
Fields where multiple candidates exist and user confirmation is needed.
let appConfig: [InferredConfigEntry]
Inferred configuration entries with full provenance and confidence.
let goal: String
The goal this session was built for.
let missing: [SuggestedShipfile.MissingValue]
Fields that are required for the goal but could not be resolved.
let nextAction: NextAction
The single next deterministic step the agent should take.
let nextQuestion: String?
The single most valuable question to ask the user, or nil if ready to proceed.
let readiness: AIReadiness
Ready-to-build diagnosis for the requested goal.
let suggestedShipfile: String
Suggested Shipfile.yml content — ready to write after reviewing missing.
let version: String
Contract version. Increment on breaking payload changes.