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.
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?"}]}'
autolets the router pick the agent; or use a specific key such aspersonal-shopper.- Add
"stream": trueto 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.
Popular AI Agent Buddies
Customer · Discovery & shopping
Personal ShopperFinds products by intent, budget, colour and occasion; compares options and recommends the best fits.
Customer · Service
Customer CareAnswers policy questions from the retailer's own documents, checks orders and return eligibility.
Customer · Service
Order Status (WISMO)"Where is my order?": status, dates and what happens next.
Customer · Service
Store LocatorNearest stores, live open/closed status in local time, hours and services.
Customer · Discovery & shopping
Shop the Look StylistBuilds a complete, coordinated outfit around any product or occasion using only real catalog items.
Merchandising & assortment
Merchandising CopilotAnswers assortment and performance questions with numbers, then recommends actions.
Inventory & supply chain
Stock-out SentinelFlags SKUs at risk of stock-out from on-hand stock vs recent sales velocity.
Store operations
Clienteling AssistantPrepares a client brief (tier, past orders) and suggests products to show a returning customer.
Marketing & CRM
Segment BuilderBuilds customer segments from tiers, cities and purchase behaviour, with counts.
Related articles
How onboarding works: from first call to live AI agents
The six steps from a first conversation to agents serving your customers: workspace, data, agents, testing, launch and team. Most retailers are live within days.
Connect your data: files, API and automatic mapping
Which tables to load, what each one unlocks, how column mapping and quality reports work, and how to keep data fresh.
Install and configure agents for your business
Browse the agent catalog, install the agents your data supports, and tune them with your own instructions.
Test your agents in the Playground before going live
A private chat with all your agents that shows which agent answered and which tools it used, plus a pre-launch checklist.
Invite your team: roles and permissions
Give every colleague their own login with the right role: owner, admin, analyst or viewer.
Languages and international setup
Console, shopper and catalog languages explained, with recommended setups for Europe, the Gulf, India and South-East Asia.
Launch the AI shopper assistant on your website or a link
Choose languages and brand, then paste one line of code or share a hosted link. What shoppers see, and how to pause it.

















