Skip to content

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

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoSession or Bearer sk_ key

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsSession or Bearer sk_ key

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsSession or Bearer sk_ key

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ key

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ key

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Session or Bearer sk_ key

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareSession or Bearer sk_ key

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsSession or Bearer sk_ key

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsSession or Bearer sk_ key

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ key

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ key

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Session or Bearer sk_ key

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSession or Bearer sk_ key

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSession or Bearer sk_ key

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySession or Bearer sk_ key

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSession or Bearer sk_ key

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

  • GET/api/v1/supaseo/projects/{project}/fixesSession or Bearer sk_ key

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historySession or Bearer sk_ key

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsSession or Bearer sk_ key

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsSession or Bearer sk_ key

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

  • GET/api/v1/supaseo/projects/{project}/alert-rulesSession or Bearer sk_ key

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesSession or Bearer sk_ key

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ key

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ key

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session or Bearer sk_ key

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsSession or Bearer sk_ key

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Session or Bearer sk_ key

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSession or Bearer sk_ key

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewSession or Bearer sk_ key

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesSession or Bearer sk_ key

    List caller workspaces

  • GET/api/v1/workspaces/currentSession or Bearer sk_ key

    Get the current workspace

  • GET/api/v1/membersSession or Bearer sk_ key

    List workspace members

  • GET/api/v1/activitySession or Bearer sk_ key

    List workspace activity

  • GET/api/v1/domainsSession or Bearer sk_ key

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsSession or Bearer sk_ key

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsSession or Bearer sk_ key

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsSession or Bearer sk_ key

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksSession or Bearer sk_ key

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Session or Bearer sk_ key

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelSession or Bearer sk_ key

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultSession or Bearer sk_ key

    Get AI task result

Content

  • POST/api/v1/content-entriesSession or Bearer sk_ key

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesSession or Bearer sk_ key

    List workspace content entries

  • GET/api/v1/contentSession or Bearer sk_ key

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Session or Bearer sk_ key

    Get one published content entry (delivery)

  • GET/api/v1/commentsSession or Bearer sk_ key

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsSession or Bearer sk_ key

    List own notifications

Feedback

  • GET/api/v1/feature-requestsSession or Bearer sk_ key

    List workspace feature requests

  • GET/api/v1/surveysSession or Bearer sk_ key

    List workspace surveys

Usage

  • GET/api/v1/usageSession or Bearer sk_ key

    Get workspace usage

Media

  • GET/api/v1/mediaSession or Bearer sk_ key

    List workspace media objects

AI

  • POST/api/v1/agent-runsSession or Bearer sk_ key

    Run a budgeted agent