Getting Started with Brellium

This page will help you get started with Brellium's API. You'll be up and running in a jiffy!

🔒Authentication

Using your client ID and secret, call the /auth endpoint to generate an access token in JWT format. This token is valid for 24 hours and can be used to access the other endpoints. It also ensures that users will only ever access their own data.

📝 Documents

To upload a new note, make use of the POST /documents endpoint, which accepts a file in the PDF format.

Once uploaded, this document can be retrieved using a GET /documents/:id endpoint.

🧐 Audits

Once a document has been uploaded, this will be processed by Brellium and an audit will be created. All audits connected to a user's account can be retrieved using the GET /audits endpoint. Singular audits can be retrieved using the GET /audits/:id endpoint.

💬 We're here to help!

If you have any questions, please don't hesitate to reach out to us at [email protected]