API reference
Report endpoints and action boundaries for agents.
OSPEA exposes workspace-scoped report endpoints for AI visibility, weekly AIO tracking, prompt libraries, competitor entities, scan status, and first-party import workflows. Private endpoints require authenticated workspace access.
Auth and scope
- Auth type
- bearer
- Workspace scope
- workspace_id path parameter
- Permission rule
- Workspace data endpoints require authenticated OSPEA access. Agents must act on behalf of an authorized workspace user.
Read endpoints
Use these before any mutation.
available
ai visibility share of voice
GET https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/share-of-voice
Weekly entity share-of-voice by platform, prompt cluster, source class, citation class, success count, failure count, mentions, citations, and visibility score.
available
weekly aio report
GET https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/weekly-aio-report
Unified weekly AIO report joining OSPEA AI scans, Google Search Console, and Bing AI Performance imports.
available
weekly aio report export
GET https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/weekly-aio-report/export
Downloadable weekly AIO report export.
available
prompt library
GET/POST/PATCH/DELETE https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/library
SavedPrompt rows used by repeatable OSPEA AI visibility scans.
available
competitor tracking
GET/POST/PATCH/DELETE https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/competitors
Tracked competitor entities used in AI visibility scans and share-of-voice reporting.
available
visibility scan status
GET https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/scan/status
Refresh-safe scan progress with expected snapshot total, latest update, and progress percentage.
available
geo audit
GET https://api.ospea.io/api/v1/aio/geo-audit
Public agent-readiness and GEO audit checks for a website.
Observation schema
Mutating endpoints
GET/POST/PATCH/DELETE https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/library
SavedPrompt rows used by repeatable OSPEA AI visibility scans.
GET/POST/PATCH/DELETE https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/competitors
Tracked competitor entities used in AI visibility scans and share-of-voice reporting.
POST https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/scan
Queues a workspace visibility scan using enabled providers. Claude web-search scans are opt-in because they consume higher provider budget.
POST https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/first-party/bing-ai-performance/import
Imports exported Bing Webmaster Tools AI Performance rows as first-party citation data for weekly AIO reporting.