Scopes y permisos
Página generada automáticamente. Corré
npm run gen:apiendocs-site/para actualizar.
Cada API key se crea con un conjunto de scopes puntuales. Un endpoint que requiere un scope que la key no tiene devuelve 403. El scope admin es bypass total (dalo solo a integraciones internas de confianza).
Todo el acceso está además scopeado a tu organización: una key nunca ve datos de otra org (salvo el override de agencia con X-Pymaia-Org, limitado a las orgs accesibles del usuario dueño de la key).
| Scope | Permite | Tipo |
|---|---|---|
agents:read |
Listar agentes disponibles | read |
agents:run |
Ejecutar agentes con mensajes | write |
ads:read |
Leer datos de Meta/Google/TikTok/etc | read |
ads:write |
Pausar/editar campañas y presupuestos | write |
analytics:read |
Leer GA4, Search Console, PageSpeed | read |
crm:read |
Leer contactos, leads, emails | read |
crm:write |
Crear/editar contactos y campañas | write |
ecommerce:read |
Leer órdenes, productos, carritos | read |
ecommerce:write |
Editar productos, responder MercadoLibre | write |
competitive:read |
Leer competitive intel | read |
competitive:write |
Regenerar SWOT, correr analyzers | write |
brand:read |
Leer brand profile y competitors | read |
brand:write |
Editar brand profile, crear competitors | write |
tasks:read |
Listar tareas y runs | read |
tasks:write |
Crear, pausar, correr tareas | write |
skills:read |
Listar skills y contenido | read |
skills:run |
Ejecutar skills declarativas | write |
actions:read |
Listar acciones propuestas/historial | read |
actions:approve |
Aprobar/rechazar acciones con guardrail | write |
memory:read |
Leer memorias de agentes | read |
memory:write |
Escribir/borrar memorias | write |
connections:read |
Ver estado de conexiones a plataformas | read |
connections:write |
Disparar sync, editar conexiones | write |
notifications:read |
Leer notificaciones y alertas | read |
notifications:write |
Marcar leídas, crear alert rules | write |
billing:read |
Ver créditos, uso IA, transacciones | read |
workspace:read |
Leer workspace files y spaces | read |
workspace:write |
Crear/editar workspace files y spaces | write |
reports:run |
Generar y enviar reports/digests | write |
admin:* |
Acceso total (bypass) | admin |
Para el detalle de qué scope pide cada endpoint, ver la Referencia.