Aller au contenu

Référence de l'API

Chaque opération de l'API REST versionnée, générée depuis le document OpenAPI publié. Un visualiseur interactif est disponible sur /api/docs.

Authentification

Les endpoints acceptent une session d'application authentifiée ou une clé d'API Authorization: Bearer sk_… à portée limitée, émise par espace de travail dans Paramètres → Développeurs. Les appels par clé agissent dans l'espace de travail de la clé ; les écritures exigent en plus la portée d'écriture.

SupaSEO

  • GET/api/v1/supaseoSession ou clé Bearer sk_

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoSession ou clé Bearer sk_

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsSession ou clé Bearer sk_

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsSession ou clé Bearer sk_

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Session ou clé Bearer sk_

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Session ou clé Bearer sk_

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Session ou clé Bearer sk_

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareSession ou clé Bearer sk_

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsSession ou clé Bearer sk_

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsSession ou clé Bearer sk_

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Session ou clé Bearer sk_

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Session ou clé Bearer sk_

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Session ou clé Bearer sk_

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSession ou clé Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSession ou clé Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySession ou clé Bearer sk_

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSession ou clé Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/fixesSession ou clé Bearer sk_

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historySession ou clé Bearer sk_

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsSession ou clé Bearer sk_

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsSession ou clé Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/alert-rulesSession ou clé Bearer sk_

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesSession ou clé Bearer sk_

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session ou clé Bearer sk_

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session ou clé Bearer sk_

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Session ou clé Bearer sk_

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsSession ou clé Bearer sk_

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Session ou clé Bearer sk_

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSession ou clé Bearer sk_

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewSession ou clé Bearer sk_

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesSession ou clé Bearer sk_

    List caller workspaces

  • GET/api/v1/workspaces/currentSession ou clé Bearer sk_

    Get the current workspace

  • GET/api/v1/membersSession ou clé Bearer sk_

    List workspace members

  • GET/api/v1/activitySession ou clé Bearer sk_

    List workspace activity

  • GET/api/v1/domainsSession ou clé Bearer sk_

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsSession ou clé Bearer sk_

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsSession ou clé Bearer sk_

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsSession ou clé Bearer sk_

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksSession ou clé Bearer sk_

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Session ou clé Bearer sk_

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelSession ou clé Bearer sk_

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultSession ou clé Bearer sk_

    Get AI task result

Content

  • POST/api/v1/content-entriesSession ou clé Bearer sk_

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesSession ou clé Bearer sk_

    List workspace content entries

  • GET/api/v1/contentSession ou clé Bearer sk_

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Session ou clé Bearer sk_

    Get one published content entry (delivery)

  • GET/api/v1/commentsSession ou clé Bearer sk_

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsSession ou clé Bearer sk_

    List own notifications

Feedback

  • GET/api/v1/feature-requestsSession ou clé Bearer sk_

    List workspace feature requests

  • GET/api/v1/surveysSession ou clé Bearer sk_

    List workspace surveys

Usage

  • GET/api/v1/usageSession ou clé Bearer sk_

    Get workspace usage

Media

  • GET/api/v1/mediaSession ou clé Bearer sk_

    List workspace media objects

AI

  • POST/api/v1/agent-runsSession ou clé Bearer sk_

    Run a budgeted agent