API reference

The API reference is auto-generated from the gateway OpenAPI specification on every gateway release.

Generated reference

Surface summary

The API is OpenAI-compatible. Core endpoints:

• POST /v1/chat/completions
• POST /v1/completions
• POST /v1/embeddings
• GET /v1/models
• GET /v1/models/{model_id}
• GET /v1/regions
• GET /v1/regions/{region_code}

Vetted-specific operational and evidence endpoints:

• GET /v1/audit-log
• GET /v1/vetted/receipts/{receipt_id}
• GET /v1/vetted/lineage/{receipt_id}
• POST /v1/vetted/evidence-pack

Compatibility notes

• The receipt shape is currently a flat vetted block.
• The response may also include an additive routing_trace block that describes the operational routing signal and whether carbon-aware routing had to degrade to the standard provider-preference path.
• Grid-intensity provenance is exposed through additive fields such as grid_intensity_source, grid_intensity_observed_at, grid_intensity_requested_at, grid_intensity_age_minutes, and grid_temporal_match.
• There is no public /v1/grid/health endpoint in the live gateway today. Source freshness is handled through the operational monitoring path and the status surface.