İçeriğe atla

API referansı

Sürümlendirilmiş REST API'nin her işlemi, yayınlanan OpenAPI belgesi üzerinden üretilmiştir. Etkileşimli görüntüleyici /api/docs adresindedir.

Kimlik doğrulama

Uç noktalar, kimliği doğrulanmış uygulama oturumunu veya Ayarlar → Geliştiriciler altında çalışma alanı başına verilen kapsamlı Authorization: Bearer sk_… API anahtarını kabul eder. Anahtarla yapılan çağrılar o anahtarın çalışma alanı içinde çalışır ve yazma işlemleri ayrıca write kapsamı gerektirir.

SupaSEO

  • GET/api/v1/supaseoOturum veya Bearer sk_ anahtarı

    List SupaSEO projects or scan history (read scope)

  • POST/api/v1/supaseoOturum veya Bearer sk_ anahtarı

    Run a SupaSEO scan (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywordsOturum veya Bearer sk_ anahtarı

    List ordered project keywords (read scope)

  • POST/api/v1/supaseo/projects/{project}/keywordsOturum veya Bearer sk_ anahtarı

    Create a project keyword (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}Oturum veya Bearer sk_ anahtarı

    Get an owned keyword (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/keywords/{keyword}Oturum veya Bearer sk_ anahtarı

    Update an owned keyword (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/keywords/{keyword}Oturum veya Bearer sk_ anahtarı

    Delete an owned keyword and its scans (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/compareOturum veya Bearer sk_ anahtarı

    Compare ordered project keywords (read scope)

  • GET/api/v1/supaseo/projects/{project}/competitorsOturum veya Bearer sk_ anahtarı

    List business competitors (read scope)

  • POST/api/v1/supaseo/projects/{project}/competitorsOturum veya Bearer sk_ anahtarı

    Save a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/competitors/{competitor}Oturum veya Bearer sk_ anahtarı

    Read a business competitor (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/competitors/{competitor}Oturum veya Bearer sk_ anahtarı

    Update a business competitor (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/competitors/{competitor}Oturum veya Bearer sk_ anahtarı

    Remove a business competitor (write scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsOturum veya Bearer sk_ anahtarı

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesOturum veya Bearer sk_ anahtarı

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

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historyOturum veya Bearer sk_ anahtarı

    Page completed competitor evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsOturum veya Bearer sk_ anahtarı

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

  • GET/api/v1/supaseo/projects/{project}/fixesOturum veya Bearer sk_ anahtarı

    Read the visibility score and prioritized fixes (read scope)

  • GET/api/v1/supaseo/projects/{project}/fixes/historyOturum veya Bearer sk_ anahtarı

    Page visibility score snapshots (read scope)

  • GET/api/v1/supaseo/projects/{project}/reviewsOturum veya Bearer sk_ anahtarı

    Read stored Google reviews and rating history (read scope)

  • POST/api/v1/supaseo/projects/{project}/reviewsOturum veya Bearer sk_ anahtarı

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

  • GET/api/v1/supaseo/projects/{project}/alert-rulesOturum veya Bearer sk_ anahtarı

    List project alert rules (read scope)

  • POST/api/v1/supaseo/projects/{project}/alert-rulesOturum veya Bearer sk_ anahtarı

    Create a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alert-rules/{rule}Oturum veya Bearer sk_ anahtarı

    Read a project alert rule (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alert-rules/{rule}Oturum veya Bearer sk_ anahtarı

    Update a project alert rule (write scope)

  • DELETE/api/v1/supaseo/projects/{project}/alert-rules/{rule}Oturum veya Bearer sk_ anahtarı

    Delete a project alert rule (write scope)

  • GET/api/v1/supaseo/projects/{project}/alertsOturum veya Bearer sk_ anahtarı

    List project change alerts (read scope)

  • PATCH/api/v1/supaseo/projects/{project}/alerts/{alert}Oturum veya Bearer sk_ anahtarı

    Mark an alert read or dismissed (write scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceOturum veya Bearer sk_ anahtarı

    Read an alert's original evidence (read scope)

  • GET/api/v1/supaseo/projects/{project}/alerts/digest-previewOturum veya Bearer sk_ anahtarı

    Preview the project alert digest (read scope)

Workspaces

  • GET/api/v1/workspacesOturum veya Bearer sk_ anahtarı

    List caller workspaces

  • GET/api/v1/workspaces/currentOturum veya Bearer sk_ anahtarı

    Get the current workspace

  • GET/api/v1/membersOturum veya Bearer sk_ anahtarı

    List workspace members

  • GET/api/v1/activityOturum veya Bearer sk_ anahtarı

    List workspace activity

  • GET/api/v1/domainsOturum veya Bearer sk_ anahtarı

    List workspace custom domains

Audit

  • GET/api/v1/audit-eventsOturum veya Bearer sk_ anahtarı

    List workspace audit events

Entitlements

  • GET/api/v1/entitlementsOturum veya Bearer sk_ anahtarı

    List current workspace entitlements

Models

  • GET/api/v1/models/requirementsOturum veya Bearer sk_ anahtarı

    Get model requirements

AI tasks

  • POST/api/v1/ai-tasksOturum veya Bearer sk_ anahtarı

    Create an AI task

  • GET/api/v1/ai-tasks/{taskId}Oturum veya Bearer sk_ anahtarı

    Get AI task status

  • POST/api/v1/ai-tasks/{taskId}/cancelOturum veya Bearer sk_ anahtarı

    Cancel an AI task

  • GET/api/v1/ai-tasks/{taskId}/resultOturum veya Bearer sk_ anahtarı

    Get AI task result

Content

  • POST/api/v1/content-entriesOturum veya Bearer sk_ anahtarı

    Capture a page into a workspace content entry

  • GET/api/v1/content-entriesOturum veya Bearer sk_ anahtarı

    List workspace content entries

  • GET/api/v1/contentOturum veya Bearer sk_ anahtarı

    List published content entries (delivery)

  • GET/api/v1/content/{entryId}Oturum veya Bearer sk_ anahtarı

    Get one published content entry (delivery)

  • GET/api/v1/commentsOturum veya Bearer sk_ anahtarı

    List comments on a content entry

Notifications

  • GET/api/v1/notificationsOturum veya Bearer sk_ anahtarı

    List own notifications

Feedback

  • GET/api/v1/feature-requestsOturum veya Bearer sk_ anahtarı

    List workspace feature requests

  • GET/api/v1/surveysOturum veya Bearer sk_ anahtarı

    List workspace surveys

Usage

  • GET/api/v1/usageOturum veya Bearer sk_ anahtarı

    Get workspace usage

Media

  • GET/api/v1/mediaOturum veya Bearer sk_ anahtarı

    List workspace media objects

AI

  • POST/api/v1/agent-runsOturum veya Bearer sk_ anahtarı

    Run a budgeted agent