AskBiz DevelopersSign in
AskBiz API

Build on the API that powers AskBiz

Vision recognition, WhatsApp messaging, and business-intelligence Q&A for African SME commerce — the same engine behind the AskBiz app, available pay-per-use.

Get startedBrowse API reference
Identify a product from a photo
curl -X POST https://askbiz.co/api/v1/scan \
  -H "x-api-key: abz_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"image": "<base64-encoded JPEG>"}'

# {"found":true,"name":"Coca-Cola 500ml","price":80,"stock_qty":24,...}

Endpoints

Five endpoints, one API key

Every endpoint documented with real request/response shapes, error codes, and pricing — not a sales page.

POST/api/v1/ask

Ask a plain-English business-intelligence question and get an answer grounded in real sales, stock, and margin data.

POST/api/v1/scan

Vision recognition — identify a product from a photo. Account-mode keys get results matched against the caller’s own AskBiz inventory.

POST/api/v1/whatsapp/send

Send a pre-approved receipt or purchase-order template over WhatsApp via AskBiz’s Meta Business API connection.

POST/api/v1/connections

Request scoped, persistent access to a specific merchant’s account — the merchant approves via a hosted confirmation page.

POST/api/v1/charges

Create a billing-on-behalf-of charge request against a merchant, collected via a hosted Stripe Checkout page.

GET/api/v1/pricing

Public, unauthenticated endpoint returning live per-endpoint prices and plan limits — check it before you integrate, not after a 402.

WEBHOOKS

React to sale.created, purchase_order.received, and stock.low events in real time instead of polling.

Academy

Learn to build on AskBiz

Structured learning paths, project tutorials, and production-readiness lessons — from your first API key to a shipped integration.

Help

Get unstuck fast

Answers to the questions developers actually ask, organized by topic — billing, auth, connections, webhooks, and errors.

Built to be trusted, not just tried

Billed only on success

A failed or rejected call is never charged — check real, live prices at GET /api/v1/pricing before you write a line of code.

Idempotent by design

Send an Idempotency-Key header on billed endpoints and a network retry returns your original result instead of double-charging.

Real merchant consent

Request scoped access to a merchant’s account and they see exactly what you’re asking for on a real consent screen — narrow-only, never widened.

Ground-truthed docs

Every parameter and error code in the docs is checked against the live route — plus a machine-readable OpenAPI spec for AI coding agents.

Ready to build?

Create an account, get an API key, and make your first call in a few minutes — no card required to start.

Create your first keyRead the docs