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
Search
- GET
/api/v1/searchOturum veya Bearer sk_ anahtarıSemantic-search workspace content
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