BuzzonChat Developer Portal

Use the BuzzonChat Public API to run AI-readiness scans, retrieve scan results, list sites, and configure outbound webhooks. The API base URL is https://api.buzzonchat.com. Create a self-service API key from the signed-in dashboard at /dashboard/api-keys; the key is shown once and must be stored securely. A free product account can start with the web scanner, while API availability and quotas follow the account’s plan.

Authentication and scopes

Requests authenticate with the X-API-Key header. Keys are least-privilege: read permits retrieving sites and scan results; write permits starting scans and creating or deleting webhook subscriptions. Request only the scopes required for the task. OAuth client authorization is not currently offered for the public API; see auth.md for the authoritative machine-readable authentication instructions.

Quick start

curl -X POST https://api.buzzonchat.com/api/v1/scan
  -H 'X-API-Key: YOUR_KEY'
  -H 'Content-Type: application/json'
  -d '{"url":"https://example.com"}'

Read the OpenAPI 3.1 specification, browse authentication instructions, and use llms.txt for agent routing guidance. A published package registry CLI is not yet available.