API 參考
根據已發布的 OpenAPI 文件列出版本化 REST API 的所有操作。互動式檢視器位於 /api/docs。
身分驗證
端點接受已驗證的應用程式工作階段,或在設定 → 開發者中為每個工作區簽發的 Authorization: Bearer sk_… 範圍受限 API 金鑰。金鑰呼叫在其工作區內執行;寫入操作還需要寫入權限。
SupaSEO
- GET
/api/v1/supaseo工作階段或 Bearer sk_ 金鑰List SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseo工作階段或 Bearer sk_ 金鑰Run a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords工作階段或 Bearer sk_ 金鑰List ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywords工作階段或 Bearer sk_ 金鑰Create a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}工作階段或 Bearer sk_ 金鑰Get an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}工作階段或 Bearer sk_ 金鑰Update an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}工作階段或 Bearer sk_ 金鑰Delete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compare工作階段或 Bearer sk_ 金鑰Compare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitors工作階段或 Bearer sk_ 金鑰List business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitors工作階段或 Bearer sk_ 金鑰Save a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}工作階段或 Bearer sk_ 金鑰Read a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}工作階段或 Bearer sk_ 金鑰Update a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}工作階段或 Bearer sk_ 金鑰Remove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors工作階段或 Bearer sk_ 金鑰Compare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidates工作階段或 Bearer sk_ 金鑰List candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/history工作階段或 Bearer sk_ 金鑰Page completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metrics工作階段或 Bearer sk_ 金鑰Read AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes工作階段或 Bearer sk_ 金鑰Read the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/history工作階段或 Bearer sk_ 金鑰Page visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviews工作階段或 Bearer sk_ 金鑰Read stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviews工作階段或 Bearer sk_ 金鑰Pull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules工作階段或 Bearer sk_ 金鑰List project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rules工作階段或 Bearer sk_ 金鑰Create a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}工作階段或 Bearer sk_ 金鑰Read a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}工作階段或 Bearer sk_ 金鑰Update a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}工作階段或 Bearer sk_ 金鑰Delete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts工作階段或 Bearer sk_ 金鑰List project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}工作階段或 Bearer sk_ 金鑰Mark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidence工作階段或 Bearer sk_ 金鑰Read an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-preview工作階段或 Bearer sk_ 金鑰Preview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspaces工作階段或 Bearer sk_ 金鑰List caller workspaces
- GET
/api/v1/workspaces/current工作階段或 Bearer sk_ 金鑰Get the current workspace
- GET
/api/v1/members工作階段或 Bearer sk_ 金鑰List workspace members
- GET
/api/v1/activity工作階段或 Bearer sk_ 金鑰List workspace activity
- GET
/api/v1/domains工作階段或 Bearer sk_ 金鑰List workspace custom domains
Audit
- GET
/api/v1/audit-events工作階段或 Bearer sk_ 金鑰List workspace audit events
Entitlements
- GET
/api/v1/entitlements工作階段或 Bearer sk_ 金鑰List current workspace entitlements
Models
- GET
/api/v1/models/requirements工作階段或 Bearer sk_ 金鑰Get model requirements
AI tasks
- POST
/api/v1/ai-tasks工作階段或 Bearer sk_ 金鑰Create an AI task
- GET
/api/v1/ai-tasks/{taskId}工作階段或 Bearer sk_ 金鑰Get AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancel工作階段或 Bearer sk_ 金鑰Cancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/result工作階段或 Bearer sk_ 金鑰Get AI task result
Content
- POST
/api/v1/content-entries工作階段或 Bearer sk_ 金鑰Capture a page into a workspace content entry
- GET
/api/v1/content-entries工作階段或 Bearer sk_ 金鑰List workspace content entries
- GET
/api/v1/content工作階段或 Bearer sk_ 金鑰List published content entries (delivery)
- GET
/api/v1/content/{entryId}工作階段或 Bearer sk_ 金鑰Get one published content entry (delivery)
- GET
/api/v1/comments工作階段或 Bearer sk_ 金鑰List comments on a content entry
Search
- GET
/api/v1/search工作階段或 Bearer sk_ 金鑰Semantic-search workspace content
Notifications
- GET
/api/v1/notifications工作階段或 Bearer sk_ 金鑰List own notifications
Feedback
- GET
/api/v1/feature-requests工作階段或 Bearer sk_ 金鑰List workspace feature requests
- GET
/api/v1/surveys工作階段或 Bearer sk_ 金鑰List workspace surveys
Usage
- GET
/api/v1/usage工作階段或 Bearer sk_ 金鑰Get workspace usage
Media
- GET
/api/v1/media工作階段或 Bearer sk_ 金鑰List workspace media objects
AI
- POST
/api/v1/agent-runs工作階段或 Bearer sk_ 金鑰Run a budgeted agent