API Reference

Every endpoint you can call directly with an API key, plus the account-management actions available from the dashboard.

Callable with your API key

These are the endpoints a third-party integration calls directly, authenticated with the x-api-key header.

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/scan3¢/call

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/send2¢/call

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.

Account management (dashboard only)

These control your account, not a specific request — they’re managed from the developer dashboard rather than called from your server with an API key.

GET/POST/PATCH/DELETE/api/v1/webhooks

Manage webhook subscriptions for sale.created, purchase_order.received, and stock.low events — an account-settings action, managed from the dashboard.

GET/POST/PATCH/DELETE/api/v1/apps

Create and manage named Apps (name, logo, redirect URI) to group your API keys under — an account-settings action, managed from the dashboard, not called with an x-api-key.

Not sure where to start? Starters has four working requests already filled in — no blank endpoint picker, no request body to write from scratch.

Machine-readable spec

The full OpenAPI 3.0 document is hand-maintained to mirror the live endpoints, reviewed alongside these reference pages on every endpoint change. If the two ever disagree, treat this page and the individual endpoint pages below as authoritative. Feed the spec to an AI coding agent, import it into Postman, or generate a typed client: askbiz.co/api/v1/openapi.json.