Agent
Get an assistant conversation with its turns
One of the caller’s saved conversations and every turn in order. A conversation that does not exist and one that
belongs to someone else both answer 404 not_found. Money in a turn’s results is in major units, as the
storefront showed it.
GET
/
v1
/
agent
/
me
/
conversations
/
{id}
Get an assistant conversation with its turns
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/me/conversations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/me/conversations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/agent/me/conversations/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/me/conversations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/agent/me/conversations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/me/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "6f1c2a4e-8b0d-4f3a-9c1e-2d7b5a9e4c10",
"title": "black hoodie under 60",
"created_at": "2026-11-08T09:36:51.526681+00:00",
"updated_at": "2026-11-08T09:37:02.410022+00:00",
"turn_count": 2,
"turns": [
{
"seq": 1,
"role": "user",
"text": "black hoodie under 60",
"at": "2026-11-08T09:36:58.120443+00:00",
"results": [],
"unresolved": [],
"draft_id": null
},
{
"seq": 2,
"role": "assistant",
"text": "Here are three that fit.",
"at": "2026-11-08T09:37:02.410022+00:00",
"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"
],
"draft_id": null
}
]
},
"evidence": [
{
"source": "agent",
"field": "conversations"
}
],
"computed_at": "2026-11-08T09:41:09.210Z",
"currency": null,
"environment": "production"
}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
⌘I
Get an assistant conversation with its turns
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/me/conversations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/me/conversations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/agent/me/conversations/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/me/conversations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/agent/me/conversations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/me/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "6f1c2a4e-8b0d-4f3a-9c1e-2d7b5a9e4c10",
"title": "black hoodie under 60",
"created_at": "2026-11-08T09:36:51.526681+00:00",
"updated_at": "2026-11-08T09:37:02.410022+00:00",
"turn_count": 2,
"turns": [
{
"seq": 1,
"role": "user",
"text": "black hoodie under 60",
"at": "2026-11-08T09:36:58.120443+00:00",
"results": [],
"unresolved": [],
"draft_id": null
},
{
"seq": 2,
"role": "assistant",
"text": "Here are three that fit.",
"at": "2026-11-08T09:37:02.410022+00:00",
"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"
],
"draft_id": null
}
]
},
"evidence": [
{
"source": "agent",
"field": "conversations"
}
],
"computed_at": "2026-11-08T09:41:09.210Z",
"currency": null,
"environment": "production"
}
