API reference
Every operation in the versioned REST API, rendered from the published OpenAPI document. An interactive viewer lives at /api/docs.
Authentication
Endpoints accept an authenticated app session or an Authorization: Bearer sk_… scoped API key issued per workspace in Settings → Developers. Key callers act inside the key's workspace; writes additionally need the write scope.
SupaSEO
- GET
/api/v1/supaseoSession or Bearer sk_ keyList SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseoSession or Bearer sk_ keyRun a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywordsSession or Bearer sk_ keyList ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywordsSession or Bearer sk_ keyCreate a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ keyGet an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ keyUpdate an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ keyDelete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compareSession or Bearer sk_ keyCompare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitorsSession or Bearer sk_ keyList business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitorsSession or Bearer sk_ keySave a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ keyRead a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ keyUpdate a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ keyRemove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSession or Bearer sk_ keyCompare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSession or Bearer sk_ keyList candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySession or Bearer sk_ keyPage completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSession or Bearer sk_ keyRead AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixesSession or Bearer sk_ keyRead the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/historySession or Bearer sk_ keyPage visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviewsSession or Bearer sk_ keyRead stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviewsSession or Bearer sk_ keyPull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rulesSession or Bearer sk_ keyList project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rulesSession or Bearer sk_ keyCreate a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ keyRead a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ keyUpdate a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ keyDelete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alertsSession or Bearer sk_ keyList project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}Session or Bearer sk_ keyMark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSession or Bearer sk_ keyRead an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-previewSession or Bearer sk_ keyPreview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspacesSession or Bearer sk_ keyList caller workspaces
- GET
/api/v1/workspaces/currentSession or Bearer sk_ keyGet the current workspace
- GET
/api/v1/membersSession or Bearer sk_ keyList workspace members
- GET
/api/v1/activitySession or Bearer sk_ keyList workspace activity
- GET
/api/v1/domainsSession or Bearer sk_ keyList workspace custom domains
Audit
- GET
/api/v1/audit-eventsSession or Bearer sk_ keyList workspace audit events
Entitlements
- GET
/api/v1/entitlementsSession or Bearer sk_ keyList current workspace entitlements
Models
- GET
/api/v1/models/requirementsSession or Bearer sk_ keyGet model requirements
AI tasks
- POST
/api/v1/ai-tasksSession or Bearer sk_ keyCreate an AI task
- GET
/api/v1/ai-tasks/{taskId}Session or Bearer sk_ keyGet AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancelSession or Bearer sk_ keyCancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/resultSession or Bearer sk_ keyGet AI task result
Content
- POST
/api/v1/content-entriesSession or Bearer sk_ keyCapture a page into a workspace content entry
- GET
/api/v1/content-entriesSession or Bearer sk_ keyList workspace content entries
- GET
/api/v1/contentSession or Bearer sk_ keyList published content entries (delivery)
- GET
/api/v1/content/{entryId}Session or Bearer sk_ keyGet one published content entry (delivery)
- GET
/api/v1/commentsSession or Bearer sk_ keyList comments on a content entry
Search
- GET
/api/v1/searchSession or Bearer sk_ keySemantic-search workspace content
Notifications
- GET
/api/v1/notificationsSession or Bearer sk_ keyList own notifications
Feedback
- GET
/api/v1/feature-requestsSession or Bearer sk_ keyList workspace feature requests
- GET
/api/v1/surveysSession or Bearer sk_ keyList workspace surveys
Usage
- GET
/api/v1/usageSession or Bearer sk_ keyGet workspace usage
Media
- GET
/api/v1/mediaSession or Bearer sk_ keyList workspace media objects
AI
- POST
/api/v1/agent-runsSession or Bearer sk_ keyRun a budgeted agent