AskBiz DevelopersSign in
AskBiz API Documentation

Build on the API that powers AskBiz

AskBiz is a phone-first point-of-sale and business-intelligence platform used by market vendors and small businesses across Africa. The same vision recognition, WhatsApp messaging, and business-question-answering that power the AskBiz app are available as a pay-per-use REST API — billed only on success, priced in the open, and safe to retry with idempotency keys.

Get startedBrowse API reference
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.

Guides

View all guides →

Scan and price a product from a photo

Use the vision endpoint to identify a product from a phone photo and match it against a merchant’s live inventory and pricing.

Send WhatsApp receipts and purchase orders

Send pre-approved receipt and purchase-order templates over WhatsApp using AskBiz’s Meta Business API connection.

Ask business-intelligence questions

Get grounded, plain-English answers about sales, margin, and stock — either from a connected AskBiz account or your own data context.

Connect to a merchant’s account with scoped permissions

Request access to a specific merchant’s inventory, have them approve it with a real consent screen, and use it across your other API calls.

Billed only on success

A failed or rejected call is never charged — see live pricing.

Idempotent by design

Send an Idempotency-Key header and a network retry never double-charges or double-sends.

Machine-readable spec

Full OpenAPI 3.0 at openapi.json — feed it directly to an AI coding agent.