Skip to main content

API & Webhooks

CONNECT EXTERNAL SYSTEMS • TRIGGER SCANS VIA API • WEBHOOK NOTIFICATIONS

API REFERENCE

POST /apiTriggerScan

Headers: x-api-key: your_key

trigger_scan

{"action": "trigger_scan", "company_name": "...", "persona": "neutral", "webhook_url": "..."}

get_scan

{"action": "get_scan", "scan_id": "..."}

list_scans

{"action": "list_scans", "company_id": "..."}

API KEYS

No API keys yet. Create one above to get started.

WEBHOOK NOTIFICATIONS

Pass a webhook_url in your trigger_scan request to receive a POST notification when the scan completes. The webhook payload includes scan_id, company_name, consensus_score, and timestamp.