API Reference
This section is the entry point for Keel’s public developer-facing API docs. It covers the main public contracts you can integrate against today: route choice, request and response shapes, retry semantics, provider coverage, and the important limits around those surfaces.
Start here
- Permits for the canonical decision contract
- Executions for the provider-neutral execution route
- Execute for the lower-level provider-shaped execution route
- Proxy Execution for the provider-native runtime routes
- Idempotency for retry and replay semantics across public surfaces
- Errors for the stable minimum error contracts
- Public API Surface for the current public endpoint index
- Provider Support for the current provider capability snapshot
Integration setup
- Quickstart for first-run setup
- SDKs for language-specific integration paths
- Configuration Reference for public-safe setup guidance
Technical references
These pages cover implementation-facing aspects of the public API and are useful for deeper integration work:
- Execution Lifecycle for the shared governed execution lifecycle and its public boundaries
- Platform Surfaces for the active public and public-adjacent route matrix
- Configuration Reference for the current runtime settings categories and non-dev hardening baseline
Current state
Today, Keel publishes:
- authored docs here for the main public decision and execution routes
- generated route and provider snapshots for the broader public surface
- public runtime routes under
https://api.keelapi.com
Planned follow-up
The public reference is still incomplete in a few areas. Planned follow-up includes:
- generated OpenAPI pages or an embedded reference viewer
- stable links for
openapi.jsonand hosted interactive docs - deeper authored API pages for usage reporting and route-specific readback flows
Last updated on Edit this page on GitHub