Referência da API
Cada operação da API REST versionada, gerada a partir do documento OpenAPI publicado. Um visualizador interativo está em /api/docs.
Autenticação
Os endpoints aceitam uma sessão de app autenticada ou uma chave de API Authorization: Bearer sk_… com escopos, emitida por espaço de trabalho em Configurações → Desenvolvedores. Chamadas com chave operam dentro do espaço de trabalho da chave; operações de escrita também exigem o escopo write.
SupaSEO
- GET
/api/v1/supaseoSessão ou chave Bearer sk_List SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseoSessão ou chave Bearer sk_Run a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywordsSessão ou chave Bearer sk_List ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywordsSessão ou chave Bearer sk_Create a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessão ou chave Bearer sk_Get an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessão ou chave Bearer sk_Update an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sessão ou chave Bearer sk_Delete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compareSessão ou chave Bearer sk_Compare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitorsSessão ou chave Bearer sk_List business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitorsSessão ou chave Bearer sk_Save a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessão ou chave Bearer sk_Read a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessão ou chave Bearer sk_Update a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sessão ou chave Bearer sk_Remove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSessão ou chave Bearer sk_Compare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSessão ou chave Bearer sk_List candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySessão ou chave Bearer sk_Page completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSessão ou chave Bearer sk_Read AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixesSessão ou chave Bearer sk_Read the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/historySessão ou chave Bearer sk_Page visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviewsSessão ou chave Bearer sk_Read stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviewsSessão ou chave Bearer sk_Pull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rulesSessão ou chave Bearer sk_List project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rulesSessão ou chave Bearer sk_Create a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessão ou chave Bearer sk_Read a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessão ou chave Bearer sk_Update a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sessão ou chave Bearer sk_Delete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alertsSessão ou chave Bearer sk_List project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}Sessão ou chave Bearer sk_Mark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSessão ou chave Bearer sk_Read an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-previewSessão ou chave Bearer sk_Preview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspacesSessão ou chave Bearer sk_List caller workspaces
- GET
/api/v1/workspaces/currentSessão ou chave Bearer sk_Get the current workspace
- GET
/api/v1/membersSessão ou chave Bearer sk_List workspace members
- GET
/api/v1/activitySessão ou chave Bearer sk_List workspace activity
- GET
/api/v1/domainsSessão ou chave Bearer sk_List workspace custom domains
Audit
- GET
/api/v1/audit-eventsSessão ou chave Bearer sk_List workspace audit events
Entitlements
- GET
/api/v1/entitlementsSessão ou chave Bearer sk_List current workspace entitlements
Models
- GET
/api/v1/models/requirementsSessão ou chave Bearer sk_Get model requirements
AI tasks
- POST
/api/v1/ai-tasksSessão ou chave Bearer sk_Create an AI task
- GET
/api/v1/ai-tasks/{taskId}Sessão ou chave Bearer sk_Get AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancelSessão ou chave Bearer sk_Cancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/resultSessão ou chave Bearer sk_Get AI task result
Content
- POST
/api/v1/content-entriesSessão ou chave Bearer sk_Capture a page into a workspace content entry
- GET
/api/v1/content-entriesSessão ou chave Bearer sk_List workspace content entries
- GET
/api/v1/contentSessão ou chave Bearer sk_List published content entries (delivery)
- GET
/api/v1/content/{entryId}Sessão ou chave Bearer sk_Get one published content entry (delivery)
- GET
/api/v1/commentsSessão ou chave Bearer sk_List comments on a content entry
Search
- GET
/api/v1/searchSessão ou chave Bearer sk_Semantic-search workspace content
Notifications
- GET
/api/v1/notificationsSessão ou chave Bearer sk_List own notifications
Feedback
- GET
/api/v1/feature-requestsSessão ou chave Bearer sk_List workspace feature requests
- GET
/api/v1/surveysSessão ou chave Bearer sk_List workspace surveys
Usage
- GET
/api/v1/usageSessão ou chave Bearer sk_Get workspace usage
Media
- GET
/api/v1/mediaSessão ou chave Bearer sk_List workspace media objects
AI
- POST
/api/v1/agent-runsSessão ou chave Bearer sk_Run a budgeted agent