콘텐츠로 건너뛰기

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