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