Skip to main content
URL base:
Usa la API REST cuando tu software necesite leer o cambiar directamente un workspace de Brein. Para un cliente de IA, empieza por MCP y OAuth.

Autenticación

Envía una API key con scope en el header x-api-key:
Una key faltante o inválida devuelve 401. Una key válida sin permiso para el workspace o la acción devuelve 403. Conserva las keys en tu gestor de secretos. Nunca las commitees ni las muestres en output para clientes.

Recursos principales

Cada ruta de workspace está limitada al workspace de la URL. No asumas que una ruta de un workspace puede usarse con las credenciales de otro.

Uso y acciones

Las lecturas y las acciones de contacto tienen reglas de costo diferentes. Una respuesta exitosa puede incluir el estado de uso actual. Si se agota una allowance, la API devuelve un 402 accionable en vez de continuar silenciosamente. Buscar un contacto es separado de guardar un contacto. Crear una campaña es separado de activarla. Una campaña no se envía hasta que la confirmación humana requerida termina correctamente.

Errores

Consulta Errores para ver la forma de respuesta y los códigos comunes.

Seguridad

Consulta Seguridad para conocer el almacenamiento de credenciales, el acceso por workspace, los límites de contactos y las reglas de email saliente.