Guides

Integrate with the REST API: agents and data in your own systems

Create an API key, call any agent (with streaming), push data automatically, and the full endpoint list.

2 Nov 2026 · 1 min read

Everything in the console is available over a REST API, so you can use the agents inside your own website, mobile app, CRM or contact centre, and push data automatically.

1. Create a key

In the console, open API & keys, give the key a name that says where it's used (e.g. mobile-app-prod) and click Create key. Copy it now: only a fingerprint is stored, so it can't be shown again. Keep it in your server's secrets, never in a website or app that customers can download.

2. Call an agent

curl https://servicebuddy.com/api/v1/agents/auto/runs \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Where is my order 1004?"}]}'
  • auto lets the router pick the agent; or use a specific key such as personal-shopper.
  • Add "stream": true to receive the answer token by token (server-sent events), plus product, store and return events you can render as cards.

3. Push data

curl https://servicebuddy.com/api/v1/datasets -H "Authorization: Bearer $API_KEY" \
  -F entity=product -F [email protected]

The file is auto-mapped and processed. Check progress with GET /api/v1/datasets/{id}.

Endpoints

Method Path Purpose
GET /api/v1/schema the standard data model
GET / POST /api/v1/datasets list / upload data
GET /api/v1/datasets/{id} status and quality report
GET /api/v1/agents catalog with readiness
POST / DELETE /api/v1/agents/{key}/install install / uninstall
POST /api/v1/agents/{key}/runs run an agent (JSON or stream)
GET /api/v1/usage runs by agent and channel

Revoke a key

Click Revoke next to it. Calls with that key stop immediately.

#onboarding#api#developers#integration

See it on your own catalog. Explore the agents

Popular AI Agent Buddies

🛍️ ● Live demo

Customer · Discovery & shopping

Personal Shopper

Finds products by intent, budget, colour and occasion; compares options and recommends the best fits.

For customers
Try it live →
💬 ● Live demo

Customer · Service

Customer Care

Answers policy questions from the retailer's own documents, checks orders and return eligibility.

For customers
Try it live →
🚚 ● Live demo

Customer · Service

Order Status (WISMO)

"Where is my order?": status, dates and what happens next.

For customers
Try it live →
📍 ● Live demo

Customer · Service

Store Locator

Nearest stores, live open/closed status in local time, hours and services.

For customers
Try it live →
👗 ● Live demo

Customer · Discovery & shopping

Shop the Look Stylist

Builds a complete, coordinated outfit around any product or occasion using only real catalog items.

For customers
Try it live →
📊 ● Live demo

Merchandising & assortment

Merchandising Copilot

Answers assortment and performance questions with numbers, then recommends actions.

For your team
Try it live →
🚨 ● Live demo

Inventory & supply chain

Stock-out Sentinel

Flags SKUs at risk of stock-out from on-hand stock vs recent sales velocity.

For your team
Try it live →
🤝 ● Live demo

Store operations

Clienteling Assistant

Prepares a client brief (tier, past orders) and suggests products to show a returning customer.

For your team
Try it live →
👥 ● Live demo

Marketing & CRM

Segment Builder

Builds customer segments from tiers, cities and purchase behaviour, with counts.

For your team
Try it live →