Test the API from the interactive console
The Console lets you fire a real request at the AskBiz API from the dashboard, using your own key, and see the actual response — status, latency, and rate-limit headers — before writing a line of integration code.
Use a abz_test_… key here if you just want to see the shape of a response —/api/v1/scan, /api/v1/whatsapp/send, and /api/v1/charges all return a realistic canned result with no real side effect on a test key: no debit, no WhatsApp message sent, no Stripe charge created. Switch to an abz_live_… key once you’re ready for the request to really happen — a billed call debits your actual balance, and /api/v1/whatsapp/send sends an actual WhatsApp message.
Every code sample in these docs is ground-truthed against the live route implementations, but reading a sample still leaves a gap between “this is what the response should look like” and seeing your own account, your own data, and your own key actually produce it. The Console closes that gap without you needing to open a terminal or write a single line of client code first.
- 1
Sign in and open the Console
The Console lives at developer.askbiz.co/dashboard/console, alongside Keys, Apps, Webhooks, and Usage. Like the rest of the dashboard, it requires you to be signed in — it isn’t part of the public, no-account /docs pages.
- 2
Pick an endpoint
The dropdown lists every endpoint callable with an x-api-key: POST /api/v1/ask, /api/v1/scan, /api/v1/whatsapp/send, /api/v1/connections, and /api/v1/charges. GET /api/v1/pricing isn’t listed — it needs no key at all, so just curl it directly. Webhook and App management aren’t listed either — both are session-only account settings, never called with an x-api-key in the first place, so there’s nothing for the console to send a key against.
- 3
Paste your API key
Paste either an abz_test_… or an abz_live_… key into the API key field — the console detects which one you’ve pasted and labels the request accordingly. It’s sent from your browser straight through to askbiz.co for that one request only — the console never stores, logs, or re-displays it, the same policy as every key and webhook secret in this product. Paste it fresh each time; it isn’t remembered between visits or endpoint switches.
- 4
Edit the request body and send it
Each endpoint starts with a realistic example body pre-filled — edit it to match what you actually want to test, then click Send request. With a test key, /api/v1/scan, /api/v1/whatsapp/send, and /api/v1/charges all return a realistic canned response with no real side effect — no debit, no WhatsApp message, no Stripe charge. With a live key, it’s a real call: a billed endpoint really debits your balance on success, and a real WhatsApp message, charge, or merchant consent email really goes out.
- 5
Read the real response
The response panel shows the actual HTTP status, latency in milliseconds, remaining requests for the current rate-limit window (from the same X-RateLimit-Remaining header documented in Authentication), and the full JSON body — exactly what your own server would receive for the same request.
What’s next
Once you’ve confirmed an endpoint behaves the way you expect, move to real code — every API Reference page has cURL, JavaScript, and Python samples for the exact same request. If you’re requesting access to a merchant’s account rather than calling the API standalone, see Connect to a merchant.
Console FAQ
Is there a sandbox or test mode, so I don’t use real credits or send a real WhatsApp message?+
Yes — create a test key (abz_test_…) from the Keys page, or toggle Test when creating one. On /api/v1/scan, /api/v1/whatsapp/send, and /api/v1/charges, a test key always returns a realistic canned response and never debits your balance, sends a real message, or creates a real Stripe charge. /api/v1/ask answers for real in both modes, since it’s never billed and only ever reads your own data. /api/v1/connections isn’t sandboxed yet — it requires a live key, since it reaches a real merchant’s inbox.
Is my API key stored when I use the console?+
No. It’s sent from your browser through to askbiz.co for that one request only and is never stored, logged, or re-displayed — the same policy as every key and webhook secret in this product. You need to paste it again each time you open the console or switch endpoints.
Why can’t I test GET /api/v1/pricing or webhooks from the console?+
Pricing needs no API key at all — it’s a fully public endpoint, so just curl or fetch it directly. Webhook and App management are session-authenticated dashboard actions, never called with an x-api-key in the first place, so there’s no key-authenticated request for the console to send.
Can someone else use my key if they get access to the console page?+
The console itself is session-gated — you have to be signed into your own developer.askbiz.co account to reach it. But the key field takes whatever key you paste in, so treat it the same as pasting a key into a terminal: don’t do it on a shared or untrusted machine.