Reference

Reference

Reference pages are lookup material. They should be stable, concise, and easy to scan. Use Using ProxAI for task walkthroughs and Developer Guide for implementation details.

Reference is not a tutorial

Reference pages can link back to task docs, but they should stay focused on exact values, contracts, and lookup tables.

Configuration and runtime

Configuration ReferenceSingle-source config.example.toml reference and links to field explanations and defaults.Defaults and LimitsDefault endpoints, timeouts, concurrency, body size, and capture defaults.Environment and FilesApp directories, generated runtime files, repository docs, and local artifact boundaries.

Routing and protocols

ProtocolsProtocol values, request paths, accepted locations, and supported conversion pairs.Compatibility MatrixProtocol-pair support for requests, responses, streams, tools, reasoning, and known lossiness.Status and Stop ReasonsTerminal status, stop_reason, finish_reason, and streaming completion signal mappings.Route MatchingRoute outcomes, protocol guards, model patterns, and fallback behavior.GlossaryShared terms for request protocols, provider protocols, phases, routes, and streaming.

Debugging and contracts

CLIRuntime flags, route overrides, capture subcommands, and default endpoints.Capture PhasesPhase boundaries, config switches, CLI phase names, and privacy risk.Error ResponsesClient-facing payload, type enum, HTTP status semantics, and preserved headers.Behavior ContractsStable promises ProxAI commits to across versions.