What does the API do?

This API provides a way to use selected parts of Briink's technology through programmatic API access so you can easily integrate it into your own systems. The provided API is tightly coupled with Briink's UI so that you can also do parts of your desired workflows via API and other parts via Briink's UI, e.g. uploading documents and processing responses programmatically and reviewing AI responses via Briink's UI.

🔑 Authentication

The Briink API uses API keys to authenticate requests.

Find out how to create and use API keys on this page: ➡️ API keys

API endpoint reference

Briink API endpoints are grouped into different categories, to make it easier for you to find the right ones.

The following list of key features guides you to the relevant endpoint documentation:

Document management: Files, URLs, Folders
ESG Questionnaires: Questionnaires, Questionnaire Responses, Instructions
ESG Chat: Chats
ESRS screenings: General Screening, ESRS Screening

Versioning

The Briink API is currently in its alpha phase, so changes to existing endpoints are likely to occur. We will keep you up to date about potential changes in the Changelog and will also notify existing API users in advance in case of breaking changes. In the future, we will likely have different API versions. Until then, this documentation is always in sync with the latest API state.

We're here to help!

If you need any help or support using the Briink API please contact us directly via the Intercom of the Briink tool or ask your question in the Discussions section of this documentation. Your feedback is also highly valued, so let us know if we can change anything to make the Briink API more suitable for your use cases.

We're exited you're here! 💚