Agent entry point
Machine-readable capabilities for AI visibility monitoring, prompt libraries, competitor tracking, and share-of-voice reporting.
Capability manifest
available
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
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
GET https://api.ospea.io/api/v1/workspaces/{workspace_id}/monitoring/weekly-aio-report/export
Downloadable weekly AIO report export.
available
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
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
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.
available
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
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.
available
GET https://api.ospea.io/api/v1/aio/geo-audit
Public agent-readiness and GEO audit checks for a website.
Trust boundary
Authenticated endpoints are scoped by workspace ID and user authorization.
Private report reads and write actions require an OSPEA account session or API credential.
Agents should use report and dry-run paths before triggering scans, imports, or mutations.
Model defaults
Use the default model for recurring visibility scans unless the workspace owner explicitly requests a premium or experimental model.
chatgpt
Premium: gpt-5.5
Requires OPENAI_API_KEY
claude
Premium: claude-opus-4-8
Requires ANTHROPIC_API_KEY
gemini
Requires GEMINI_USE_VERTEX with GCP project/location credentials, or GEMINI_API_KEY fallback
perplexity
Requires PERPLEXITY_API_KEY
deepseek
Premium: deepseek-v4-pro
Requires DEEPSEEK_API_KEY
Boundaries
publisher, placement, attribution, and consent storage is not enabled
/backlinks/editorial/*
exchange site, match, consent, and rate-limit storage is not enabled
/backlinks/exchange/sites, /backlinks/exchange/matches, /backlinks/exchange/initiate
durable lead submission storage is not enabled
/landing-pages/{page_id}/submissions, /landing-pages/{page_id}/submit
durable job persistence and progress tracking are not enabled
/api/v1/serp/scrape/batch
durable scan job storage and progress tracking are not enabled
/workspaces/{workspace_id}/onboarding/scan, /workspaces/{workspace_id}/onboarding/scan/{job_id}
Source classes