Quickstart

You need an AskBiz developer account and one API key to make your first call. The fastest endpoint to start with is POST /api/v1/ask — it’s free within your monthly plan quota (no wallet debit), so you can test your integration before any billed endpoint is involved.

1. 1

   Create an account and sign in

   Go to developer.askbiz.co/dashboard and sign in (or sign up if you’re new). This is the same account you’ll use to generate keys, inspect usage, and manage webhooks.

2. 2

   Create an API key

   Open the Keys page in the dashboard and create a key. It defaults to a test key (abz_test_…) — safe to experiment with, since /scan, /whatsapp/send, and /charges all return realistic canned responses on a test key with nothing real happening. Switch to live when you’re ready to ship. You’ll also choose a mode: an account-mode key is tied to your own AskBiz business and automatically reads your real profile, currency, and uploaded data — use this if you’re building on your own AskBiz account. A generic-mode key has no AskBiz account behind it, so you supply all context yourself in each request — use this if you’re integrating AskBiz into someone else’s product. Copy the key now; treat it like a password.

3. 3

   Make your first call

   POST /api/v1/ask is the lowest-friction endpoint to start with — it’s free within your monthly plan quota, no wallet debit involved. Send your key in the x-api-key header and a question in the body.

   cURLJavaScriptPython

   curl -X POST https://askbiz.co/api/v1/ask \
     -H "x-api-key: abz_live_your_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "question": "What were my best-selling products last week?"
     }'

   A successful response looks like this:

   200 — success

   {
     "answer": "Your top seller last week was Coca-Cola 500ml, with 142 units sold...",
     "insight_header": "Coca-Cola 500ml led sales",
     "verdict": "watch",
     "verdict_sentence": "Strong demand, but stock is running low.",
     "confidence": "high",
     "kpi_cards": [],
     "chart": null,
     "table": null,
     "recommendations": [
       "Reorder Coca-Cola 500ml before the weekend rush"
     ],
     "follow_up_questions": [
       "How does this compare to the week before?"
     ],
     "meta": {
       "model": "askbiz-v1",
       "latency_ms": 840,
       "requests_remaining": 97
     }
   }

4. 4

   Check your usage and spend

   Open the Usage page in the dashboard to see calls made, your remaining monthly quota, and any wallet spend from billed endpoints like /api/v1/scan and /api/v1/whatsapp/send. /api/v1/ask calls count against your quota but never debit your wallet.

5. 5

   Explore the full API and guides

   Once your first call works, browse the API Reference for every endpoint’s full request/response shape and error codes, or jump into a task-oriented Guide — scanning products, sending WhatsApp messages, connecting to a merchant, billing on behalf of a merchant, and webhooks.

What’s next

For endpoints that do cost money — scan (3¢ per successful call) and whatsapp/send (2¢ per successful send) — read Errors and retries first so you understand how Idempotency-Key keeps a network retry from double-charging you. Check GET /api/v1/pricing any time — it’s public, no key required.