Guide
API overview
A starter overview for the BotConsent API shape, designed for hosted policies and developer integrations.
Base resources
- Sites: verified domains and subdomains.
- Policies: category preferences, bot overrides, and published versions.
- Events: crawler sightings, policy changes, and enforcement actions.
- Exports: compliance-ready snapshots for legal, security, or publishing teams.
Example request
GET /v1/sites/example.com/policy Authorization: Bearer bc_live_...
Example response
{
"domain": "example.com",
"policy_url": "https://botconsent.com/policies/example.com",
"categories": {
"search_indexing": "allow",
"ai_training": "disallow",
"commercial_scraping": "manual_review"
}
}