コンテンツへスキップ

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

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