Zum Inhalt springen

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üssel

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoSitzung oder Bearer-sk_-Schlüssel

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsSitzung oder Bearer-sk_-Schlüssel

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsSitzung oder Bearer-sk_-Schlüssel

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-Schlüssel

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-Schlüssel

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Sitzung oder Bearer-sk_-Schlüssel

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareSitzung oder Bearer-sk_-Schlüssel

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsSitzung oder Bearer-sk_-Schlüssel

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsSitzung oder Bearer-sk_-Schlüssel

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-Schlüssel

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-Schlüssel

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Sitzung oder Bearer-sk_-Schlüssel

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSitzung oder Bearer-sk_-Schlüssel

    Compare competitors across Maps, Google and AI (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSitzung oder Bearer-sk_-Schlüssel

    List candidates from the keyword's latest Maps scan (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySitzung oder Bearer-sk_-Schlüssel

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSitzung oder Bearer-sk_-Schlüssel

    Read AI answer metrics and trends for a prompt (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixesSitzung oder Bearer-sk_-Schlüssel

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historySitzung oder Bearer-sk_-Schlüssel

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsSitzung oder Bearer-sk_-Schlüssel

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsSitzung oder Bearer-sk_-Schlüssel

    Pull 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üssel

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesSitzung oder Bearer-sk_-Schlüssel

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-Schlüssel

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-Schlüssel

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sitzung oder Bearer-sk_-Schlüssel

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsSitzung oder Bearer-sk_-Schlüssel

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Sitzung oder Bearer-sk_-Schlüssel

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSitzung oder Bearer-sk_-Schlüssel

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewSitzung oder Bearer-sk_-Schlüssel

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesSitzung oder Bearer-sk_-Schlüssel

    List caller workspaces

  • GET/api/v1/workspaces/currentSitzung oder Bearer-sk_-Schlüssel

    Get the current workspace

  • GET/api/v1/membersSitzung oder Bearer-sk_-Schlüssel

    List workspace members

  • GET/api/v1/activitySitzung oder Bearer-sk_-Schlüssel

    List workspace activity

  • GET/api/v1/domainsSitzung oder Bearer-sk_-Schlüssel

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsSitzung oder Bearer-sk_-Schlüssel

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsSitzung oder Bearer-sk_-Schlüssel

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsSitzung oder Bearer-sk_-Schlüssel

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksSitzung oder Bearer-sk_-Schlüssel

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Sitzung oder Bearer-sk_-Schlüssel

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelSitzung oder Bearer-sk_-Schlüssel

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultSitzung oder Bearer-sk_-Schlüssel

    Get AI task result

Content

  • POST/api/v1/content-entriesSitzung oder Bearer-sk_-Schlüssel

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesSitzung oder Bearer-sk_-Schlüssel

    List workspace content entries

  • GET/api/v1/contentSitzung oder Bearer-sk_-Schlüssel

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Sitzung oder Bearer-sk_-Schlüssel

    Get one published content entry (delivery)

  • GET/api/v1/commentsSitzung oder Bearer-sk_-Schlüssel

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsSitzung oder Bearer-sk_-Schlüssel

    List own notifications

Feedback

  • GET/api/v1/feature-requestsSitzung oder Bearer-sk_-Schlüssel

    List workspace feature requests

  • GET/api/v1/surveysSitzung oder Bearer-sk_-Schlüssel

    List workspace surveys

Usage

  • GET/api/v1/usageSitzung oder Bearer-sk_-Schlüssel

    Get workspace usage

Media

  • GET/api/v1/mediaSitzung oder Bearer-sk_-Schlüssel

    List workspace media objects

AI

  • POST/api/v1/agent-runsSitzung oder Bearer-sk_-Schlüssel

    Run a budgeted agent