REST API
Package: BASIC
1. General
A REST API (Representational State Transfer Application Programming Interface) is a standardised programming interface through which external systems and applications can access and process data.
brainX provides a REST API through which records can be read, created, updated and deleted in brainX. The interface is aimed exclusively at software developers with the relevant expertise and enables the connection of external systems as well as the automation of processes outside of brainX.
For connecting brainX to n8n, an official Community Node verified by n8n is available. It enables the integration of brainX into n8n workflows without manual API implementation. Further information can be found on the [n8n integration]() page.
1.1. REST API Documentation
The REST API documentation is not aimed at brainX users or brainX administrators, but exclusively at software developers/programmers with the relevant expertise.
The documentation of the brainX REST API (version 1.1.0) can be accessed at the following URL: https://meine-brainx-domain/api/docs
The URL is composed as follows: https:// followed by the domain of the respective brainX instance and the path /api/docs. The domain corresponds to the URL through which brainX is accessed in the browser.
Example: If the brainX URL is https://mustermann.brainx.app, then the API documentation can be accessed at https://mustermann.brainx.app/api/docs.
2. Authentication
Access to the brainX REST API is carried out via basic authentication (Basic Auth) using a username and a specially generated API password. The API password is not identical to the user's login password.
2.1. Generating an API password
The API password is generated under My Settings:
- In brainX, navigate to My Settings
- In the API password section, generate a new password
- Save the password immediately – it is displayed only once after generation and cannot be viewed afterwards
Several API passwords can be active at the same time. It is recommended to generate a separate API password for each use case. This way, in the event of a security incident or a change, an individual password can be deactivated or replaced without affecting other integrations.
2.2. Credentials
The following details are required for authentication:
| Field | Description |
|---|---|
| Base URL | URL of the brainX instance, e.g. https://meine-brainx-domain |
| Username | Username of the brainX user |
| API password | Generated API password (not the login password) |