APIリファレンス
バージョン管理されたREST APIのすべての操作を 公開済みOpenAPIドキュメント から生成。インタラクティブビューアーは /api/docs にあります。
認証
エンドポイントは認証済みアプリセッション、または設定 → 開発者でワークスペースごとに発行されるスコープ付き Authorization: Bearer sk_… APIキーを受け付けます。キーでの呼び出しはそのキーのワークスペース内で動作し、書き込み操作には write スコープも必要です。
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