API-referentie
Elke bewerking in de versioned REST API, gegenereerd uit het gepubliceerde OpenAPI-document. Een interactieve viewer staat op /api/docs.
Authenticatie
Endpoints accepteren een geverifieerde app-sessie of een Authorization: Bearer sk_… API-sleutel met scopes, uitgegeven per werkruimte onder Instellingen → Ontwikkelaars. Aanroepen met een sleutel werken binnen de werkruimte van de sleutel; schrijfbewerkingen vereisen ook de write-scope.
SupaSEO
- GET
/api/v1/supaseoSessie of Bearer sk_-sleutelList SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseoSessie of Bearer sk_-sleutelRun a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywordsSessie of Bearer sk_-sleutelList ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywordsSessie of Bearer sk_-sleutelCreate a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutelGet an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutelUpdate an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutelDelete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compareSessie of Bearer sk_-sleutelCompare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitorsSessie of Bearer sk_-sleutelList business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitorsSessie of Bearer sk_-sleutelSave a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutelRead a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutelUpdate a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutelRemove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSessie of Bearer sk_-sleutelCompare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSessie of Bearer sk_-sleutelList candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySessie of Bearer sk_-sleutelPage completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSessie of Bearer sk_-sleutelRead AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixesSessie of Bearer sk_-sleutelRead the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/historySessie of Bearer sk_-sleutelPage visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviewsSessie of Bearer sk_-sleutelRead stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviewsSessie of Bearer sk_-sleutelPull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rulesSessie of Bearer sk_-sleutelList project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rulesSessie of Bearer sk_-sleutelCreate a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutelRead a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutelUpdate a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutelDelete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alertsSessie of Bearer sk_-sleutelList project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}Sessie of Bearer sk_-sleutelMark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSessie of Bearer sk_-sleutelRead an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-previewSessie of Bearer sk_-sleutelPreview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspacesSessie of Bearer sk_-sleutelList caller workspaces
- GET
/api/v1/workspaces/currentSessie of Bearer sk_-sleutelGet the current workspace
- GET
/api/v1/membersSessie of Bearer sk_-sleutelList workspace members
- GET
/api/v1/activitySessie of Bearer sk_-sleutelList workspace activity
- GET
/api/v1/domainsSessie of Bearer sk_-sleutelList workspace custom domains
Audit
- GET
/api/v1/audit-eventsSessie of Bearer sk_-sleutelList workspace audit events
Entitlements
- GET
/api/v1/entitlementsSessie of Bearer sk_-sleutelList current workspace entitlements
Models
- GET
/api/v1/models/requirementsSessie of Bearer sk_-sleutelGet model requirements
AI tasks
- POST
/api/v1/ai-tasksSessie of Bearer sk_-sleutelCreate an AI task
- GET
/api/v1/ai-tasks/{taskId}Sessie of Bearer sk_-sleutelGet AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancelSessie of Bearer sk_-sleutelCancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/resultSessie of Bearer sk_-sleutelGet AI task result
Content
- POST
/api/v1/content-entriesSessie of Bearer sk_-sleutelCapture a page into a workspace content entry
- GET
/api/v1/content-entriesSessie of Bearer sk_-sleutelList workspace content entries
- GET
/api/v1/contentSessie of Bearer sk_-sleutelList published content entries (delivery)
- GET
/api/v1/content/{entryId}Sessie of Bearer sk_-sleutelGet one published content entry (delivery)
- GET
/api/v1/commentsSessie of Bearer sk_-sleutelList comments on a content entry
Search
- GET
/api/v1/searchSessie of Bearer sk_-sleutelSemantic-search workspace content
Notifications
- GET
/api/v1/notificationsSessie of Bearer sk_-sleutelList own notifications
Feedback
- GET
/api/v1/feature-requestsSessie of Bearer sk_-sleutelList workspace feature requests
- GET
/api/v1/surveysSessie of Bearer sk_-sleutelList workspace surveys
Usage
- GET
/api/v1/usageSessie of Bearer sk_-sleutelGet workspace usage
Media
- GET
/api/v1/mediaSessie of Bearer sk_-sleutelList workspace media objects
AI
- POST
/api/v1/agent-runsSessie of Bearer sk_-sleutelRun a budgeted agent