Quickstart

Create an Account

To create an account click on Sign up at the homepage and fill out the form. After you have successfully created your account you will be redirected to your personal dashboard. If you have already created an account sign in here and skip to the next step.

Create an API Key

Once logged in, you'll need to request beta access to the BReact OS. Click on API Keys in your dashboard and submit a request for beta access. Your request will be reviewed and you'll receive an email notification when approved. After approval, you can return to the API Keys page to generate and copy your API key.

Purchase Credits

To use the BReact OS services, you'll need credits in your account. Visit the Credits page to purchase credits based on your usage needs. We offer flexible pay-per-use pricing to accommodate different scales of usage.

If you'd like to try out our services first, you can request trial credits by contacting us. When reaching out, please include:

• A brief description of your project
• How you plan to use the BReact OS
• Estimated usage volume
• Timeline for implementation

We'll review your request and get back to you with trial credits if approved.

Try it!

It's best practise to use the BReact SDK when interacting with the BReact OS. However, to try if the API key is working just use a curl request.

Let's see what services the OS provides:

Now lets call the service summary with the endpoint summarize:

The response will contain a process_id and access_token, for example:

Poll for the results using process_id and access_token:

Setup the BReact SDK

When building your application it is recommended to use the BReact SDK, because it handles authentication, result polling, error handling and much more out of the box. You can also take a closer look at the SDK documentation and on GitHub.

The setup process is very simple. First install the SDK.

Setup the following environment variable:

Then import the SDK into your project and create a client:

Now we call the service summary with the endpoint summarize again, but this time with the SDK.

And it's done! You can now use the SDK to call any services of the BReact OS and build your desired application.