Referencia de API
Cada operación de la API REST versionada, renderizada desde el documento OpenAPI publicado. Hay un visor interactivo en /api/docs.
Autenticación
Los endpoints aceptan una sesión de aplicación autenticada o una clave de API con ámbitos Authorization: Bearer sk_… emitida por espacio de trabajo en Configuración → Desarrolladores. Quienes llaman con clave actúan dentro del espacio de esa clave; las escrituras además necesitan el ámbito de escritura.
SupaSEO
- GET
/api/v1/supaseoSesión o clave Bearer sk_List SupaSEO projects or scan history (read scope)
- POST
/api/v1/supaseoSesión o clave Bearer sk_Run a SupaSEO scan (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywordsSesión o clave Bearer sk_List ordered project keywords (read scope)
- POST
/api/v1/supaseo/projects/{project}/keywordsSesión o clave Bearer sk_Create a project keyword (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sesión o clave Bearer sk_Get an owned keyword (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sesión o clave Bearer sk_Update an owned keyword (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/keywords/{keyword}Sesión o clave Bearer sk_Delete an owned keyword and its scans (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/compareSesión o clave Bearer sk_Compare ordered project keywords (read scope)
- GET
/api/v1/supaseo/projects/{project}/competitorsSesión o clave Bearer sk_List business competitors (read scope)
- POST
/api/v1/supaseo/projects/{project}/competitorsSesión o clave Bearer sk_Save a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sesión o clave Bearer sk_Read a business competitor (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sesión o clave Bearer sk_Update a business competitor (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/competitors/{competitor}Sesión o clave Bearer sk_Remove a business competitor (write scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitorsSesión o clave Bearer sk_Compare competitors across Maps, Google and AI (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/candidatesSesión o clave Bearer sk_List candidates from the keyword's latest Maps scan (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/competitors/historySesión o clave Bearer sk_Page completed competitor evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/keywords/{keyword}/aeo-metricsSesión o clave Bearer sk_Read AI answer metrics and trends for a prompt (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixesSesión o clave Bearer sk_Read the visibility score and prioritized fixes (read scope)
- GET
/api/v1/supaseo/projects/{project}/fixes/historySesión o clave Bearer sk_Page visibility score snapshots (read scope)
- GET
/api/v1/supaseo/projects/{project}/reviewsSesión o clave Bearer sk_Read stored Google reviews and rating history (read scope)
- POST
/api/v1/supaseo/projects/{project}/reviewsSesión o clave Bearer sk_Pull reviews or draft a reply with the buyer's provider keys (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rulesSesión o clave Bearer sk_List project alert rules (read scope)
- POST
/api/v1/supaseo/projects/{project}/alert-rulesSesión o clave Bearer sk_Create a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sesión o clave Bearer sk_Read a project alert rule (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sesión o clave Bearer sk_Update a project alert rule (write scope)
- DELETE
/api/v1/supaseo/projects/{project}/alert-rules/{rule}Sesión o clave Bearer sk_Delete a project alert rule (write scope)
- GET
/api/v1/supaseo/projects/{project}/alertsSesión o clave Bearer sk_List project change alerts (read scope)
- PATCH
/api/v1/supaseo/projects/{project}/alerts/{alert}Sesión o clave Bearer sk_Mark an alert read or dismissed (write scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/{alert}/evidenceSesión o clave Bearer sk_Read an alert's original evidence (read scope)
- GET
/api/v1/supaseo/projects/{project}/alerts/digest-previewSesión o clave Bearer sk_Preview the project alert digest (read scope)
Workspaces
- GET
/api/v1/workspacesSesión o clave Bearer sk_List caller workspaces
- GET
/api/v1/workspaces/currentSesión o clave Bearer sk_Get the current workspace
- GET
/api/v1/membersSesión o clave Bearer sk_List workspace members
- GET
/api/v1/activitySesión o clave Bearer sk_List workspace activity
- GET
/api/v1/domainsSesión o clave Bearer sk_List workspace custom domains
Audit
- GET
/api/v1/audit-eventsSesión o clave Bearer sk_List workspace audit events
Entitlements
- GET
/api/v1/entitlementsSesión o clave Bearer sk_List current workspace entitlements
Models
- GET
/api/v1/models/requirementsSesión o clave Bearer sk_Get model requirements
AI tasks
- POST
/api/v1/ai-tasksSesión o clave Bearer sk_Create an AI task
- GET
/api/v1/ai-tasks/{taskId}Sesión o clave Bearer sk_Get AI task status
- POST
/api/v1/ai-tasks/{taskId}/cancelSesión o clave Bearer sk_Cancel an AI task
- GET
/api/v1/ai-tasks/{taskId}/resultSesión o clave Bearer sk_Get AI task result
Content
- POST
/api/v1/content-entriesSesión o clave Bearer sk_Capture a page into a workspace content entry
- GET
/api/v1/content-entriesSesión o clave Bearer sk_List workspace content entries
- GET
/api/v1/contentSesión o clave Bearer sk_List published content entries (delivery)
- GET
/api/v1/content/{entryId}Sesión o clave Bearer sk_Get one published content entry (delivery)
- GET
/api/v1/commentsSesión o clave Bearer sk_List comments on a content entry
Search
- GET
/api/v1/searchSesión o clave Bearer sk_Semantic-search workspace content
Notifications
- GET
/api/v1/notificationsSesión o clave Bearer sk_List own notifications
Feedback
- GET
/api/v1/feature-requestsSesión o clave Bearer sk_List workspace feature requests
- GET
/api/v1/surveysSesión o clave Bearer sk_List workspace surveys
Usage
- GET
/api/v1/usageSesión o clave Bearer sk_Get workspace usage
Media
- GET
/api/v1/mediaSesión o clave Bearer sk_List workspace media objects
AI
- POST
/api/v1/agent-runsSesión o clave Bearer sk_Run a budgeted agent