Sign InGet Started
AboutBlog
AI API Mode

Agentic AI API

Our brain, your UI. Full headless access to agentic commerce — product search, AI chat, and monetization APIs for custom integrations.

Endpoints

API Endpoints

Five endpoints power the entire agentic commerce experience. Authenticate, create sessions, stream AI responses, search products, and get contextual suggestions.

POST/api/widget/auth-init

Authenticate with your API key and receive widget configuration.

POST/api/widget/threads

Create a new conversation session. Returns a thread ID for message streaming.

POST/api/widget/threads/[id]/messages

Send a user query and receive an SSE stream — AI text, products, articles, and ads.

POST/api/widget/search

Direct product search. Returns a JSON array of affiliate products with pricing.

POST/api/widget/context

Get contextual suggestions for a page URL. Powers proactive engagement chips.

Use Cases

Build Anything With Our AI

The API gives you the full power of Brambles.ai without any UI constraints. Here's what teams are building.

Custom Search UI

Build your own product search experience. Use our search endpoint to power custom search bars, comparison tools, or curated product feeds with full affiliate monetization.

Cashback Integration

Inject real-time cashback rates, coupon codes, and custom product feeds into your existing UI. Layer monetization onto any user experience without our widget.

White-Label Solutions

Enterprise media networks, custom deployments, native apps. Full API access means you control every pixel while we handle AI, affiliate matching, and revenue.

Response Format

What You Get Back

The SSE stream delivers structured event types. Parse each one to build your custom agentic commerce experience.

text_delta

Streamed AI answer tokens — render progressively for a real-time chat experience.

products

Affiliate product results with titles, images, pricing, and monetized click URLs.

articles

Publisher content citations — relevant articles from the site's own content index.

suggested_prompts

AI-generated follow-up questions to keep the conversation going.

programmatic_contextual_impressions

Programmatic contextual ad placements with offer IDs and destination URLs for revenue tracking.

FAQ

Frequently Asked Questions

Do I need to use the Brambles widget UI?

No. The AI API gives you full headless access to our agentic commerce engine. You build the frontend however you want — React, native app, terminal, or any custom UI — and call our endpoints for AI chat, product search, and monetization.

What format does the streaming chat response use?

The /threads/[id]/messages endpoint returns Server-Sent Events (SSE). Each event has a type — text_delta for streamed AI text, function_call_output for product / article / video / coupon payloads, message and metadata for response packaging, and a contextual-ad event channel for programmatic ad placements.

Is there a rate limit on API calls?

Enterprise API access includes generous rate limits tailored to your volume. Contact our sales team to discuss your expected traffic and we'll configure limits that fit your integration.

Can I use the product search endpoint without the chat?

Yes. The /api/widget/search endpoint returns a JSON array of affiliate products directly — no conversation session required. It's perfect for building custom search bars, product feeds, or cashback integrations.

Our AI brain. Your custom UI.

Full headless API access to agentic commerce — built for enterprise teams.

Talk to our team about custom API integrations and enterprise pricing.

✓ Enterprise SLA ✓ Custom rate limits ✓ Dedicated support