API Access Overview
AskBiz API access for developers. What's available via the API, how to get started, supported endpoints, and plan requirements.
API Availability#
The AskBiz API is available on the Business plan (ยฃ39/mo). It allows developers to:
- Query your Business Pulse score programmatically
- Retrieve anomaly alerts
- Pull Daily Brief content
- Submit questions to the AskBiz AI and receive structured JSON responses
- Push data from custom sources not covered by native connectors
Base URL#
All API requests are made to: https://api.askbiz.co/v1/
All endpoints require authentication via Bearer token. See the Authentication article for setup.
Key Endpoints#
GET /pulseโ current Business Pulse score and dimension breakdownGET /alertsโ list of active anomaly alertsGET /brief/latestโ today's Daily Brief as structured JSONPOST /askโ submit a question; returns AI answer as JSONPOST /data/pushโ push custom data records to your AskBiz datasetGET /tools/fx-riskโ retrieve FX Risk Modeller resultsGET /tools/landed-costโ run a landed cost calculation
Use Cases#
Common developer use cases:
- Embed your Business Pulse score in your internal dashboard
- Set up a Slack bot that delivers your Daily Brief each morning
- Trigger a question to AskBiz from a Zapier workflow when an order threshold is hit
- Build a custom mobile app for your team that surfaces AskBiz data
- Push sales data from a custom POS system that doesn't have a native connector
Frequently Asked Questions
Was this article helpful?
Still stuck? Email our support team.