Create a quote
curl --request POST \
--url https://your-kordless-instance.com/v1/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offeringId": "<string>",
"factors": {},
"idempotencyKey": "<string>"
}
'import requests
url = "https://your-kordless-instance.com/v1/quotes"
payload = {
"businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offeringId": "<string>",
"factors": {},
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
businessId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bookId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
offeringId: '<string>',
factors: {},
idempotencyKey: '<string>'
})
};
fetch('https://your-kordless-instance.com/v1/quotes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-kordless-instance.com/v1/quotes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'businessId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bookId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'offeringId' => '<string>',
'factors' => [
],
'idempotencyKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-kordless-instance.com/v1/quotes"
payload := strings.NewReader("{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-kordless-instance.com/v1/quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-kordless-instance.com/v1/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"quoteIntent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotencyKey": "<string>",
"requestCorrelationId": "<string>",
"inputs": {
"offeringId": "<string>",
"factors": {}
},
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
},
"quoteReceipt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteIntentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"computation": {
"currency": "<string>",
"lineItems": [
{
"label": "<string>",
"amountMinor": 123,
"ruleId": "<string>"
}
],
"totalMinor": 1,
"paymentTerms": {
"depositBasisPoints": 5000,
"depositMinor": 1,
"balanceDueMinor": 1
},
"conditions": [
"<string>"
],
"derivation": [
{
"sequence": 1,
"ruleId": "<string>",
"ruleType": "<string>",
"reason": "<string>",
"deltaMinor": 123,
"runningTotalMinor": 1
}
]
},
"missingInputs": [
"<string>"
],
"failure": {
"code": "<string>",
"message": "<string>"
},
"idempotencyKey": "<string>",
"requestCorrelationId": "<string>",
"latencyMs": 1,
"createdAt": "2023-11-07T05:31:56Z"
}
},
"requestId": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "A valid API key is required.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "quote_scope_not_found",
"message": "The Quote scope does not exist.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "idempotency_conflict",
"message": "The idempotency key was already used with a different payload.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "invalid_quote_request",
"message": "A Business, offering, and factor selections are required.",
"requestId": "req_9f8e7d6c",
"details": {
"fields": {
"offeringId": [
"Required"
]
}
}
}
}Quotes
Create a quote
Creates a Quote Intent against the Environment bound to the API key, pins the Environment’s published Book Version, evaluates it deterministically, and returns the Intent with its immutable Receipt. Identical inputs under one idempotency key replay the original Quote.
POST
/
v1
/
quotes
Create a quote
curl --request POST \
--url https://your-kordless-instance.com/v1/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offeringId": "<string>",
"factors": {},
"idempotencyKey": "<string>"
}
'import requests
url = "https://your-kordless-instance.com/v1/quotes"
payload = {
"businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offeringId": "<string>",
"factors": {},
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
businessId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bookId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
offeringId: '<string>',
factors: {},
idempotencyKey: '<string>'
})
};
fetch('https://your-kordless-instance.com/v1/quotes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-kordless-instance.com/v1/quotes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'businessId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bookId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'offeringId' => '<string>',
'factors' => [
],
'idempotencyKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-kordless-instance.com/v1/quotes"
payload := strings.NewReader("{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-kordless-instance.com/v1/quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-kordless-instance.com/v1/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"offeringId\": \"<string>\",\n \"factors\": {},\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"quoteIntent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotencyKey": "<string>",
"requestCorrelationId": "<string>",
"inputs": {
"offeringId": "<string>",
"factors": {}
},
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
},
"quoteReceipt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quoteIntentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"computation": {
"currency": "<string>",
"lineItems": [
{
"label": "<string>",
"amountMinor": 123,
"ruleId": "<string>"
}
],
"totalMinor": 1,
"paymentTerms": {
"depositBasisPoints": 5000,
"depositMinor": 1,
"balanceDueMinor": 1
},
"conditions": [
"<string>"
],
"derivation": [
{
"sequence": 1,
"ruleId": "<string>",
"ruleType": "<string>",
"reason": "<string>",
"deltaMinor": 123,
"runningTotalMinor": 1
}
]
},
"missingInputs": [
"<string>"
],
"failure": {
"code": "<string>",
"message": "<string>"
},
"idempotencyKey": "<string>",
"requestCorrelationId": "<string>",
"latencyMs": 1,
"createdAt": "2023-11-07T05:31:56Z"
}
},
"requestId": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "A valid API key is required.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "quote_scope_not_found",
"message": "The Quote scope does not exist.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "idempotency_conflict",
"message": "The idempotency key was already used with a different payload.",
"requestId": "req_9f8e7d6c"
}
}{
"error": {
"code": "invalid_quote_request",
"message": "A Business, offering, and factor selections are required.",
"requestId": "req_9f8e7d6c",
"details": {
"fields": {
"offeringId": [
"Required"
]
}
}
}
}Authorizations
Secret API key (sk_test_… or sk_live_…). The key binds a Workspace, Project, and Environment.
Body
application/json
Maximum string length:
80Factor selections by factor id. null means "answered as unknown".
Show child attributes
Show child attributes
Optional. Generated as auto_<uuid> when omitted.
Required string length:
8 - 120⌘I