Перейти к содержимому

Справочник API

Каждая операция версионированного REST API, сгенерированная из опубликованного OpenAPI-документа. Интерактивный просмотрщик находится на /api/docs.

Аутентификация

Конечные точки принимают аутентифицированную сессию приложения или API-ключ Authorization: Bearer sk_… с областями, выданный по рабочей области в «Настройки → Разработчики». Вызовы ключом работают в рабочей области этого ключа, а операции записи также требуют области 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