Draft a cart from an intent
A hosted helper: an intent such as “a birthday gift for a runner, under 80” and an optional budget
become a priced, stock-checked draft. The request is turned into constraints, the catalogue is searched
for in-stock products, and a model selects from those results only, by variant — it never supplies a
price. Every amount in the draft comes from the quote. over_budget reports whether the quoted total
exceeds the budget.
It debits the store’s AI credits for both model steps; usage reports the total. A publishable key is
subject to the merchant’s daily limit on public helper spend, as described on POST /v1/agent/interpret.
With a marketplace operator key the candidates come only from that marketplace’s sellers, each
selection names its seller (merchant_store_id), and the draft is priced with the marketplace quote
(quote.sellers). Both model steps are paid from the marketplace operator’s own AI credits,
never a seller’s, and are refused on the same terms as POST /v1/agent/interpret. The draft is read back with
GET /v1/agent/cart-drafts/{id} using the same key and turned into an order with
POST /v1/agent/checkout-intents.
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "a hoodie for my brother",
"budget": 60
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent"
payload = {
"intent": "a hoodie for my brother",
"budget": 60
}
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({intent: 'a hoodie for my brother', budget: 60})
};
fetch('https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent', 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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent",
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([
'intent' => 'a hoodie for my brother',
'budget' => 60
]),
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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent"
payload := strings.NewReader("{\n \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent")
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 \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\n}"
response = http.request(request)
puts response.read_body{
"data": {
"draft": {
"id": "b45506d9-6f01-4ac5-aaf7-7fc3a19e8863",
"items": [
{
"quantity": 1,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a"
}
],
"source": "intent",
"expires_at": "2026-09-29T21:53:40.76+00:00",
"applied_at": null,
"created_at": "2026-09-28T21:53:40.856357+00:00"
},
"quote": {
"lines": [
{
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"name": "Galactic Zip Hoodie",
"variant_name": "Grey / M",
"sku": "FEED-HOODIE-GRY-M",
"quantity": 1,
"unit_price": 48,
"list_price": 48,
"line_total": 48,
"category_name": "Wearables",
"available": true,
"stock": 25,
"unavailable_reason": null
}
],
"subtotal": 48,
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"status": "address_required",
"amount": null,
"description": null,
"free_threshold": null,
"is_free": null
},
"tax": {
"status": "address_required",
"amount": null,
"source": null,
"prices_include_tax": false
},
"grand_total": 48,
"total_is_final": false,
"unavailable_count": 0,
"currency": "EUR",
"shipping_address": null
},
"selections": [
{
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"quantity": 1,
"reason": "A grey zip hoodie within the budget"
}
],
"constraints": {
"query": "hoodie",
"price_max": 60,
"in_stock_only": true
},
"unresolved": [
"for my brother"
],
"over_budget": false
},
"evidence": [
{
"source": "pricing",
"operation": "GET /v1/prices/products/{id}",
"id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"field": "resolved_price"
},
{
"source": "promotions",
"operation": "POST /v1/promotions/calculate-best",
"field": "discount"
}
],
"computed_at": "2026-09-28T21:53:40.945Z",
"currency": "EUR",
"environment": "sandbox",
"usage": {
"credits_debited": 0.001873,
"model_class": "fast"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): state-changingPOSTcalls require a secret key, for store and marketplace keys alike;GET /v1/auth/meaccepts either key - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Limited publishable keys:
A publishable key can be limited to the products that carry one tag (for example starter:jewellery), created from
the store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.
- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and
subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of
in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.
A product outside the slice answers
404, as if it did not exist. - A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,
a review, a promotion calculation, a storefront event) answers
403with the error codeout_of_scope, and nothing is written or reserved. An order is refused as a whole. - A route that carries no slice behaviour is not available to the key: it answers
403withendpoint_not_allowed. - Orders placed through such a key record the tag on the order's attribution as
key_scope. - Secret keys and connected-app keys cannot be limited.
- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.
Body
Response
The draft
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "a hoodie for my brother",
"budget": 60
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent"
payload = {
"intent": "a hoodie for my brother",
"budget": 60
}
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({intent: 'a hoodie for my brother', budget: 60})
};
fetch('https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent', 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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent",
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([
'intent' => 'a hoodie for my brother',
'budget' => 60
]),
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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent"
payload := strings.NewReader("{\n \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\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://api.tybritelabs.com/v1/agent/cart-drafts/from-intent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/cart-drafts/from-intent")
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 \"intent\": \"a hoodie for my brother\",\n \"budget\": 60\n}"
response = http.request(request)
puts response.read_body{
"data": {
"draft": {
"id": "b45506d9-6f01-4ac5-aaf7-7fc3a19e8863",
"items": [
{
"quantity": 1,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a"
}
],
"source": "intent",
"expires_at": "2026-09-29T21:53:40.76+00:00",
"applied_at": null,
"created_at": "2026-09-28T21:53:40.856357+00:00"
},
"quote": {
"lines": [
{
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"name": "Galactic Zip Hoodie",
"variant_name": "Grey / M",
"sku": "FEED-HOODIE-GRY-M",
"quantity": 1,
"unit_price": 48,
"list_price": 48,
"line_total": 48,
"category_name": "Wearables",
"available": true,
"stock": 25,
"unavailable_reason": null
}
],
"subtotal": 48,
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"status": "address_required",
"amount": null,
"description": null,
"free_threshold": null,
"is_free": null
},
"tax": {
"status": "address_required",
"amount": null,
"source": null,
"prices_include_tax": false
},
"grand_total": 48,
"total_is_final": false,
"unavailable_count": 0,
"currency": "EUR",
"shipping_address": null
},
"selections": [
{
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"quantity": 1,
"reason": "A grey zip hoodie within the budget"
}
],
"constraints": {
"query": "hoodie",
"price_max": 60,
"in_stock_only": true
},
"unresolved": [
"for my brother"
],
"over_budget": false
},
"evidence": [
{
"source": "pricing",
"operation": "GET /v1/prices/products/{id}",
"id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"field": "resolved_price"
},
{
"source": "promotions",
"operation": "POST /v1/promotions/calculate-best",
"field": "discount"
}
],
"computed_at": "2026-09-28T21:53:40.945Z",
"currency": "EUR",
"environment": "sandbox",
"usage": {
"credits_debited": 0.001873,
"model_class": "fast"
}
}
