Add a turn to an assistant conversation
Saves one turn exactly as the storefront showed it: what the shopper wrote (role: user) or what the assistant
answered (role: assistant), with the products shown (money in major units), the parts of the request that could
not be matched, and a cart draft if one was offered. Nothing is generated or changed. A conversation holds at most
200 turns (409 conversation_full); start a new one after that.
Send an Idempotency-Key to make a retry safe: the same key on the same conversation returns the turn already
saved, with 200, instead of adding it twice.
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "assistant",
"text": "Here are three that fit.",
"results": [
{
"product_id": "0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f",
"variant_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
"name": "Heavyweight Hoodie, Black",
"price": 49.5,
"list_price": 60,
"currency": "USD",
"thumbnail_url": "https://cdn.example.com/p/hoodie-black.webp",
"in_stock": true
}
],
"unresolved": [
"for my brother"
]
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns"
payload = {
"role": "assistant",
"text": "Here are three that fit.",
"results": [
{
"product_id": "0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f",
"variant_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
"name": "Heavyweight Hoodie, Black",
"price": 49.5,
"list_price": 60,
"currency": "USD",
"thumbnail_url": "https://cdn.example.com/p/hoodie-black.webp",
"in_stock": True
}
],
"unresolved": ["for my brother"]
}
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({
role: 'assistant',
text: 'Here are three that fit.',
results: [
{
product_id: '0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f',
variant_id: '7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d',
name: 'Heavyweight Hoodie, Black',
price: 49.5,
list_price: 60,
currency: 'USD',
thumbnail_url: 'https://cdn.example.com/p/hoodie-black.webp',
in_stock: true
}
],
unresolved: ['for my brother']
})
};
fetch('https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns', 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/me/conversations/{id}/turns",
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([
'role' => 'assistant',
'text' => 'Here are three that fit.',
'results' => [
[
'product_id' => '0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f',
'variant_id' => '7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d',
'name' => 'Heavyweight Hoodie, Black',
'price' => 49.5,
'list_price' => 60,
'currency' => 'USD',
'thumbnail_url' => 'https://cdn.example.com/p/hoodie-black.webp',
'in_stock' => true
]
],
'unresolved' => [
'for my brother'
]
]),
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/me/conversations/{id}/turns"
payload := strings.NewReader("{\n \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\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/me/conversations/{id}/turns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns")
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 \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"turn": {
"seq": 100,
"role": "user",
"text": "<string>",
"at": "2023-11-07T05:31:56Z",
"results": [
{
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 1,
"list_price": 1,
"currency": "<string>",
"thumbnail_url": "<string>",
"in_stock": true
}
],
"unresolved": [
"<string>"
],
"draft_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"turn_count": 100
},
"evidence": [
{
"source": "<string>",
"field": "<string>"
}
],
"computed_at": "2023-11-07T05:31:56Z",
"environment": "production",
"currency": null
}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.
Headers
Body
Response
The same Idempotency-Key was already used on this conversation; the turn saved then is returned.
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "assistant",
"text": "Here are three that fit.",
"results": [
{
"product_id": "0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f",
"variant_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
"name": "Heavyweight Hoodie, Black",
"price": 49.5,
"list_price": 60,
"currency": "USD",
"thumbnail_url": "https://cdn.example.com/p/hoodie-black.webp",
"in_stock": true
}
],
"unresolved": [
"for my brother"
]
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns"
payload = {
"role": "assistant",
"text": "Here are three that fit.",
"results": [
{
"product_id": "0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f",
"variant_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
"name": "Heavyweight Hoodie, Black",
"price": 49.5,
"list_price": 60,
"currency": "USD",
"thumbnail_url": "https://cdn.example.com/p/hoodie-black.webp",
"in_stock": True
}
],
"unresolved": ["for my brother"]
}
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({
role: 'assistant',
text: 'Here are three that fit.',
results: [
{
product_id: '0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f',
variant_id: '7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d',
name: 'Heavyweight Hoodie, Black',
price: 49.5,
list_price: 60,
currency: 'USD',
thumbnail_url: 'https://cdn.example.com/p/hoodie-black.webp',
in_stock: true
}
],
unresolved: ['for my brother']
})
};
fetch('https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns', 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/me/conversations/{id}/turns",
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([
'role' => 'assistant',
'text' => 'Here are three that fit.',
'results' => [
[
'product_id' => '0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f',
'variant_id' => '7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d',
'name' => 'Heavyweight Hoodie, Black',
'price' => 49.5,
'list_price' => 60,
'currency' => 'USD',
'thumbnail_url' => 'https://cdn.example.com/p/hoodie-black.webp',
'in_stock' => true
]
],
'unresolved' => [
'for my brother'
]
]),
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/me/conversations/{id}/turns"
payload := strings.NewReader("{\n \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\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/me/conversations/{id}/turns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/me/conversations/{id}/turns")
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 \"role\": \"assistant\",\n \"text\": \"Here are three that fit.\",\n \"results\": [\n {\n \"product_id\": \"0c6b1f9a-3d2e-4b7a-8e5f-1a2b3c4d5e6f\",\n \"variant_id\": \"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\",\n \"name\": \"Heavyweight Hoodie, Black\",\n \"price\": 49.5,\n \"list_price\": 60,\n \"currency\": \"USD\",\n \"thumbnail_url\": \"https://cdn.example.com/p/hoodie-black.webp\",\n \"in_stock\": true\n }\n ],\n \"unresolved\": [\n \"for my brother\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"turn": {
"seq": 100,
"role": "user",
"text": "<string>",
"at": "2023-11-07T05:31:56Z",
"results": [
{
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 1,
"list_price": 1,
"currency": "<string>",
"thumbnail_url": "<string>",
"in_stock": true
}
],
"unresolved": [
"<string>"
],
"draft_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"turn_count": 100
},
"evidence": [
{
"source": "<string>",
"field": "<string>"
}
],
"computed_at": "2023-11-07T05:31:56Z",
"environment": "production",
"currency": null
}
