Starters
Four working requests, ready to run — pick one, copy it, or open it pre-filled in the dashboard Console. Every one of these is safe to try on a test key: nothing real happens.
What a starter is
A starter is a real, working request against one of AskBiz’s core endpoints — the exact endpoint, the exact request body, already filled in. There’s no blank endpoint picker to figure out and no JSON to write from a spec. Signed-in developers can open any of these directly in the dashboard Console, pre-filled and ready to send with one click — the code below is exactly what that click sends.
Every starter is chosen specifically because it’s safe to run on a test key (abz_test_…): nothing real is charged, no real WhatsApp message goes out, and no real merchant is contacted. Try one, see the real response shape, then switch to a live key when you’re ready to ship.
Answer a business question
Ask in plain English and get a grounded answer about sales, margin, or stock.
curl -X POST https://askbiz.co/api/v1/ask \
-H "x-api-key: abz_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{"question": "Which product has the worst margin this month?"}'Price a product from a photo
Snap a photo of a product and get back its name, price, and stock level.
curl -X POST https://askbiz.co/api/v1/scan \
-H "x-api-key: abz_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{"image": "<base64-encoded JPEG>"}'Send a WhatsApp receipt
Text a customer their receipt the moment a sale happens.
curl -X POST https://askbiz.co/api/v1/whatsapp/send \
-H "x-api-key: abz_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{"phone": "+254712345678", "template": "receipt", "text": "Thank you for your purchase!"}'Bill a merchant
Ask a merchant to approve and pay a charge, collected through a hosted checkout page.
curl -X POST https://askbiz.co/api/v1/charges \
-H "x-api-key: abz_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{"merchant_email": "merchant@example.com", "amount_cents": 5000, "currency": "gbp", "description": "Monthly subscription"}'Try these interactively
Reading the code above is one way to start. The faster way: sign in (or create a free account) and open any starter directly from developer.askbiz.co/dashboard/starters — it deep-links straight into the Console with the endpoint and body already selected, so you only need to paste your own key and press send.
Starters FAQ
Do I need an account to use these examples?+
No — every request on this page is copy-pasteable with just an API key from a curl, JS, or Python shell. Signing in only matters if you want the one-click, pre-filled version inside the dashboard Console.
Will running these cost me anything?+
Not on a test key. Every starter here is chosen because it’s fully safe on a test key (abz_test_…) — no real wallet debit, no real WhatsApp send, no real charge. See Build safely with a sandbox key for exactly what each endpoint does differently in test mode.
Why isn’t there a starter for /api/v1/connections?+
A connection request reaches a real merchant’s real inbox and consent screen — there’s no way to make that safe to try casually, on a test key or otherwise. It’s the one core endpoint left out of Starters for that reason.