Skip to main content
The Kordless API gives you programmatic access to the same published Book, deterministic evaluator, and immutable Receipts that the hosted surfaces use. It is one product — not a separate developer product.

​
What you can do

Every entry runs the identical pinned-Version pipeline, so the same inputs produce the same Receipt regardless of surface — hosted, embedded, or headless. For the full endpoint reference with request and response schemas, see the API reference.

​
Core resources

  • Quote Intent — the persisted request: inputs, idempotency key, source, and a status of created | requires_input | processing | succeeded | failed | expired.
  • Quote Receipt — the immutable outcome evidence. succeeded carries the full computation (line items, total in integer minor units, payment terms, conditions, derivation) and the pinned Book Version; requires_input carries structured missing-input paths and never an amount; failed carries a machine-readable failure code.
  • Book Version — the compiled, checksummed artifact a Quote pins. Republishing never rewrites an issued Receipt.

​
The integration path

  1. Publish — a Book version to the Environment you want to quote against.
  2. Authenticate — create a Test API key in the Console Developers section.
  3. Quote — POST /v1/quotes with an idempotencyKey.
  4. Handle outcomes — render succeeded, collect requires_input, route failed.
  5. Distribute — share the hosted quote link, embed the components, or stay headless.
  6. Go Live — publish to the Live Environment and use a Live key when the Live key lifecycle opens.

​
Where to start

​
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 or a booking system. Quotes end at the Receipt; downstream handoff is yours.
  • The API does not expose Book authoring or publication internals beyond the member routes the portal itself uses.
  • The API does not expose billing or plan management.