What you can do
Every request uses the same published Live Book version and the same deterministic evaluator. The same request produces the same result across the workspace, hosted pages, embeds, and the API.
For the full endpoint reference with request and response schemas, see the API reference.
The integration path
A typical integration follows this sequence:- Authenticate — Create a Test API key in the Developers page. Use it as a bearer token.
- Read the quote spec — Fetch the published Book’s services and required inputs so your code knows what to send.
- Simulate — Run a non-persistent simulation to see what the evaluator would return.
- Produce a quote — Create a formal, persisted quote with an
Idempotency-Key. - Create a commitment — When the customer accepts, create a hold, deposit, or handoff.
- Receive webhooks — Subscribe to commitment events at your own endpoint.
- Go Live — Mint a Live key and repeat the same calls against production.
Where to start
- New to the API? Start with the Quickstart.
- Need to understand keys and scopes? Read Authentication.
- Want to embed quoting in your site? See Hosted quote path and Components and embeds.
- Building a downstream integration? Read Webhooks.
- Need the full endpoint schema? See the API reference.
Base URL
All API requests are sent to your Kordless instance base URL under/v1/. The exact base URL depends on your deployment.
What the API is not
- The API is not a CRM. Customer records are contextual to quotes.
- The API does not expose Book authoring or verification. Those are workspace operations.
- The API does not expose billing or plan management. Those are admin operations.
- The API does not expose internal routes. Only the operations listed above are public.