Naar inhoud gaan

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_-sleutel

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoSessie of Bearer sk_-sleutel

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsSessie of Bearer sk_-sleutel

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsSessie of Bearer sk_-sleutel

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutel

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutel

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessie of Bearer sk_-sleutel

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareSessie of Bearer sk_-sleutel

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsSessie of Bearer sk_-sleutel

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsSessie of Bearer sk_-sleutel

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutel

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutel

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessie of Bearer sk_-sleutel

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSessie of Bearer sk_-sleutel

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSessie of Bearer sk_-sleutel

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySessie of Bearer sk_-sleutel

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSessie of Bearer sk_-sleutel

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

  • GET/api/v1/supaseo/projects/{project}/fixesSessie of Bearer sk_-sleutel

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historySessie of Bearer sk_-sleutel

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsSessie of Bearer sk_-sleutel

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsSessie of Bearer sk_-sleutel

    Pull reviews or draft a reply with the buyer's provider keys (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rulesSessie of Bearer sk_-sleutel

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesSessie of Bearer sk_-sleutel

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutel

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutel

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessie of Bearer sk_-sleutel

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsSessie of Bearer sk_-sleutel

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Sessie of Bearer sk_-sleutel

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSessie of Bearer sk_-sleutel

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewSessie of Bearer sk_-sleutel

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesSessie of Bearer sk_-sleutel

    List caller workspaces

  • GET/api/v1/workspaces/currentSessie of Bearer sk_-sleutel

    Get the current workspace

  • GET/api/v1/membersSessie of Bearer sk_-sleutel

    List workspace members

  • GET/api/v1/activitySessie of Bearer sk_-sleutel

    List workspace activity

  • GET/api/v1/domainsSessie of Bearer sk_-sleutel

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsSessie of Bearer sk_-sleutel

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsSessie of Bearer sk_-sleutel

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsSessie of Bearer sk_-sleutel

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksSessie of Bearer sk_-sleutel

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Sessie of Bearer sk_-sleutel

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelSessie of Bearer sk_-sleutel

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultSessie of Bearer sk_-sleutel

    Get AI task result

Content

  • POST/api/v1/content-entriesSessie of Bearer sk_-sleutel

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesSessie of Bearer sk_-sleutel

    List workspace content entries

  • GET/api/v1/contentSessie of Bearer sk_-sleutel

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Sessie of Bearer sk_-sleutel

    Get one published content entry (delivery)

  • GET/api/v1/commentsSessie of Bearer sk_-sleutel

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsSessie of Bearer sk_-sleutel

    List own notifications

Feedback

  • GET/api/v1/feature-requestsSessie of Bearer sk_-sleutel

    List workspace feature requests

  • GET/api/v1/surveysSessie of Bearer sk_-sleutel

    List workspace surveys

Usage

  • GET/api/v1/usageSessie of Bearer sk_-sleutel

    Get workspace usage

Media

  • GET/api/v1/mediaSessie of Bearer sk_-sleutel

    List workspace media objects

AI

  • POST/api/v1/agent-runsSessie of Bearer sk_-sleutel

    Run a budgeted agent