List the agent tools
The tool manifest for this store. Each entry names a tool, its HTTP operation, a JSON Schema for its
request and for its response data, the credential it needs, and its cost class: deterministic tools
read store data and cost what any storefront read costs; hosted_helper tools run a model and debit the
store’s AI credits.
hosted_helpers_available says whether the two hosted helpers can be called right now. When it is
false, calling one with a publishable key returns 403 helpers_unavailable, the same answer whatever
the reason; a secret key receives the reason. The deterministic tools are always available.
assistant carries the name and logo the merchant has given their shopping assistant, so an assistant
shopping the store can introduce itself the way the store does. Each field is null when the merchant
has not set it.
Every Agent API response shares one envelope: data, evidence (where each figure was read from),
computed_at, currency and environment.
Called with a marketplace operator key, the manifest lists the tools that span every seller of that
marketplace — search, compare, alternatives, quote, the hosted helpers and the drafts they make, and the
checkout intent tools — with marketplace: true,
and the marketplace shapes of their requests and responses. The single-store tools answer 403 to a
marketplace key; they need the store’s own key.
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/capabilities \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/capabilities"
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/capabilities', 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/capabilities",
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/capabilities"
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/capabilities")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/capabilities")
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": {
"tools": [
{
"name": "get_capabilities",
"method": "GET",
"path": "/v1/agent/capabilities",
"auth": "publishable",
"cost_class": "deterministic",
"description": "This manifest.",
"request_schema": null,
"response_schema": {
"type": "object",
"properties": {
"tools": {
"type": "array"
},
"hosted_helpers_available": {
"type": "boolean"
}
}
}
},
{
"name": "search",
"method": "POST",
"path": "/v1/agent/search",
"auth": "publishable",
"cost_class": "deterministic",
"description": "Constraint search. Each result lists which constraints it satisfied.",
"request_schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 300,
"description": "Free text matched semantically where the store supports it, else against name, brand, category, SKU and tags."
},
"price_min": {
"type": "number",
"minimum": 0
},
"price_max": {
"type": "number",
"minimum": 0
},
"category": {
"type": "string",
"description": "A category or subcategory name."
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Attribute name → wanted value, e.g. {\"color\": \"black\"}."
},
"in_stock_only": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10
}
},
"additionalProperties": false
},
"response_schema": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string",
"format": "uuid"
},
"variant_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"brand": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"currency": {
"type": "string"
},
"in_stock": {
"type": "boolean"
},
"match_reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"constraint": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
}
}
},
"total_matched": {
"type": "integer"
}
}
}
}
],
"hosted_helpers_available": false,
"assistant": {
"name": null,
"logo_url": null
},
"response_contract": {
"data": "object",
"evidence": "array",
"computed_at": "date-time",
"currency": "string|null",
"environment": "production|sandbox"
}
},
"evidence": [
{
"source": "agent",
"field": "tools"
},
{
"source": "store",
"field": "hosted_helpers"
}
],
"computed_at": "2026-09-28T21:53:20.260Z",
"currency": null,
"environment": "sandbox"
}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.
Response
The manifest
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/capabilities \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/capabilities"
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/capabilities', 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/capabilities",
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/capabilities"
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/capabilities")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/capabilities")
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": {
"tools": [
{
"name": "get_capabilities",
"method": "GET",
"path": "/v1/agent/capabilities",
"auth": "publishable",
"cost_class": "deterministic",
"description": "This manifest.",
"request_schema": null,
"response_schema": {
"type": "object",
"properties": {
"tools": {
"type": "array"
},
"hosted_helpers_available": {
"type": "boolean"
}
}
}
},
{
"name": "search",
"method": "POST",
"path": "/v1/agent/search",
"auth": "publishable",
"cost_class": "deterministic",
"description": "Constraint search. Each result lists which constraints it satisfied.",
"request_schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 300,
"description": "Free text matched semantically where the store supports it, else against name, brand, category, SKU and tags."
},
"price_min": {
"type": "number",
"minimum": 0
},
"price_max": {
"type": "number",
"minimum": 0
},
"category": {
"type": "string",
"description": "A category or subcategory name."
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Attribute name → wanted value, e.g. {\"color\": \"black\"}."
},
"in_stock_only": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10
}
},
"additionalProperties": false
},
"response_schema": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string",
"format": "uuid"
},
"variant_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"brand": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"currency": {
"type": "string"
},
"in_stock": {
"type": "boolean"
},
"match_reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"constraint": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
}
}
},
"total_matched": {
"type": "integer"
}
}
}
}
],
"hosted_helpers_available": false,
"assistant": {
"name": null,
"logo_url": null
},
"response_contract": {
"data": "object",
"evidence": "array",
"computed_at": "date-time",
"currency": "string|null",
"environment": "production|sandbox"
}
},
"evidence": [
{
"source": "agent",
"field": "tools"
},
{
"source": "store",
"field": "hosted_helpers"
}
],
"computed_at": "2026-09-28T21:53:20.260Z",
"currency": null,
"environment": "sandbox"
}
