Vai al contenuto

Riferimento API

Tutte le operazioni dell'API REST con versione, dal documento OpenAPI pubblicato. Un visualizzatore interattivo è disponibile su /api/docs.

Autenticazione

Gli endpoint accettano una sessione autenticata o una chiave API Authorization: Bearer sk_… con ambiti specifici, creata per lo spazio di lavoro in Impostazioni → Sviluppatori. Le chiamate con chiave operano nel suo spazio di lavoro; le scritture richiedono anche l'ambito di scrittura.

SupaSEO

  • GET/api/v1/supaseoSessione o chiave Bearer sk_

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoSessione o chiave Bearer sk_

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsSessione o chiave Bearer sk_

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsSessione o chiave Bearer sk_

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessione o chiave Bearer sk_

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessione o chiave Bearer sk_

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessione o chiave Bearer sk_

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareSessione o chiave Bearer sk_

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsSessione o chiave Bearer sk_

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsSessione o chiave Bearer sk_

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessione o chiave Bearer sk_

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessione o chiave Bearer sk_

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessione o chiave Bearer sk_

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSessione o chiave Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSessione o chiave Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySessione o chiave Bearer sk_

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSessione o chiave Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/fixesSessione o chiave Bearer sk_

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historySessione o chiave Bearer sk_

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsSessione o chiave Bearer sk_

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsSessione o chiave Bearer sk_

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

  • GET/api/v1/supaseo/projects/{project}/alert-rulesSessione o chiave Bearer sk_

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesSessione o chiave Bearer sk_

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessione o chiave Bearer sk_

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessione o chiave Bearer sk_

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessione o chiave Bearer sk_

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsSessione o chiave Bearer sk_

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Sessione o chiave Bearer sk_

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSessione o chiave Bearer sk_

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewSessione o chiave Bearer sk_

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesSessione o chiave Bearer sk_

    List caller workspaces

  • GET/api/v1/workspaces/currentSessione o chiave Bearer sk_

    Get the current workspace

  • GET/api/v1/membersSessione o chiave Bearer sk_

    List workspace members

  • GET/api/v1/activitySessione o chiave Bearer sk_

    List workspace activity

  • GET/api/v1/domainsSessione o chiave Bearer sk_

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsSessione o chiave Bearer sk_

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsSessione o chiave Bearer sk_

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsSessione o chiave Bearer sk_

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksSessione o chiave Bearer sk_

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Sessione o chiave Bearer sk_

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelSessione o chiave Bearer sk_

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultSessione o chiave Bearer sk_

    Get AI task result

Content

  • POST/api/v1/content-entriesSessione o chiave Bearer sk_

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesSessione o chiave Bearer sk_

    List workspace content entries

  • GET/api/v1/contentSessione o chiave Bearer sk_

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Sessione o chiave Bearer sk_

    Get one published content entry (delivery)

  • GET/api/v1/commentsSessione o chiave Bearer sk_

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsSessione o chiave Bearer sk_

    List own notifications

Feedback

  • GET/api/v1/feature-requestsSessione o chiave Bearer sk_

    List workspace feature requests

  • GET/api/v1/surveysSessione o chiave Bearer sk_

    List workspace surveys

Usage

  • GET/api/v1/usageSessione o chiave Bearer sk_

    Get workspace usage

Media

  • GET/api/v1/mediaSessione o chiave Bearer sk_

    List workspace media objects

AI

  • POST/api/v1/agent-runsSessione o chiave Bearer sk_

    Run a budgeted agent