API-Referenz
Jede Operation der versionierten REST-API, gerendert aus dem veröffentlichten OpenAPI-Dokument. Eine interaktive Ansicht gibt es unter /api/docs.
Authentifizierung
Endpunkte akzeptieren eine authentifizierte App-Sitzung oder einen pro Workspace unter Einstellungen → Entwickler ausgestellten Authorization: Bearer sk_…-API-Schlüssel mit Scopes. Aufrufe mit Schlüssel agieren im Workspace des Schlüssels; Schreibvorgänge benötigen zusätzlich den Write-Scope.
SupaSEO
- GET
/api/v1/supaseoSitzung oder Bearer-sk_-SchlüsselList SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseoSitzung oder Bearer-sk_-SchlüsselRun a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywordsSitzung oder Bearer-sk_-SchlüsselList ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywordsSitzung oder Bearer-sk_-SchlüsselCreate a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-SchlüsselGet an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-SchlüsselUpdate an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-SchlüsselDelete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compareSitzung oder Bearer-sk_-SchlüsselCompare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitorsSitzung oder Bearer-sk_-SchlüsselList business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitorsSitzung oder Bearer-sk_-SchlüsselSave a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-SchlüsselRead a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-SchlüsselUpdate a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-SchlüsselRemove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSitzung oder Bearer-sk_-SchlüsselCompare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSitzung oder Bearer-sk_-SchlüsselList candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySitzung oder Bearer-sk_-SchlüsselPage completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSitzung oder Bearer-sk_-SchlüsselRead AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixesSitzung oder Bearer-sk_-SchlüsselRead the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/historySitzung oder Bearer-sk_-SchlüsselPage visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviewsSitzung oder Bearer-sk_-SchlüsselRead stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviewsSitzung oder Bearer-sk_-SchlüsselPull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rulesSitzung oder Bearer-sk_-SchlüsselList project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rulesSitzung oder Bearer-sk_-SchlüsselCreate a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-SchlüsselRead a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-SchlüsselUpdate a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-SchlüsselDelete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alertsSitzung oder Bearer-sk_-SchlüsselList project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}Sitzung oder Bearer-sk_-SchlüsselMark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSitzung oder Bearer-sk_-SchlüsselRead an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-previewSitzung oder Bearer-sk_-SchlüsselPreview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspacesSitzung oder Bearer-sk_-SchlüsselList caller workspaces
- GET
/api/v1/workspaces/currentSitzung oder Bearer-sk_-SchlüsselGet the current workspace
- GET
/api/v1/membersSitzung oder Bearer-sk_-SchlüsselList workspace members
- GET
/api/v1/activitySitzung oder Bearer-sk_-SchlüsselList workspace activity
- GET
/api/v1/domainsSitzung oder Bearer-sk_-SchlüsselList workspace custom domains
Audit
- GET
/api/v1/audit-eventsSitzung oder Bearer-sk_-SchlüsselList workspace audit events
Entitlements
- GET
/api/v1/entitlementsSitzung oder Bearer-sk_-SchlüsselList current workspace entitlements
Models
- GET
/api/v1/models/requirementsSitzung oder Bearer-sk_-SchlüsselGet model requirements
AI tasks
- POST
/api/v1/ai-tasksSitzung oder Bearer-sk_-SchlüsselCreate an AI task
- GET
/api/v1/ai-tasks/{taskId}Sitzung oder Bearer-sk_-SchlüsselGet AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancelSitzung oder Bearer-sk_-SchlüsselCancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/resultSitzung oder Bearer-sk_-SchlüsselGet AI task result
Content
- POST
/api/v1/content-entriesSitzung oder Bearer-sk_-SchlüsselCapture a page into a workspace content entry
- GET
/api/v1/content-entriesSitzung oder Bearer-sk_-SchlüsselList workspace content entries
- GET
/api/v1/contentSitzung oder Bearer-sk_-SchlüsselList published content entries (delivery)
- GET
/api/v1/content/{entryId}Sitzung oder Bearer-sk_-SchlüsselGet one published content entry (delivery)
- GET
/api/v1/commentsSitzung oder Bearer-sk_-SchlüsselList comments on a content entry
Search
- GET
/api/v1/searchSitzung oder Bearer-sk_-SchlüsselSemantic-search workspace content
Notifications
- GET
/api/v1/notificationsSitzung oder Bearer-sk_-SchlüsselList own notifications
Feedback
- GET
/api/v1/feature-requestsSitzung oder Bearer-sk_-SchlüsselList workspace feature requests
- GET
/api/v1/surveysSitzung oder Bearer-sk_-SchlüsselList workspace surveys
Usage
- GET
/api/v1/usageSitzung oder Bearer-sk_-SchlüsselGet workspace usage
Media
- GET
/api/v1/mediaSitzung oder Bearer-sk_-SchlüsselList workspace media objects
AI
- POST
/api/v1/agent-runsSitzung oder Bearer-sk_-SchlüsselRun a budgeted agent