Skip to main content

BRX Quickstart Guide

This guide will help you get started with BRX quickly. You’ll learn how to set up your environment, create your first BRK, and execute it.

Prerequisites

Before you begin, make sure you have:
  • A BRX account (sign up at app.brx.ai if you don’t have one)
  • Node.js 14+ installed (for using the Node.js SDK)
  • Basic understanding of JavaScript/TypeScript (for the examples in this guide)

Installation

Install the BRX Node.js SDK

Get Your API Key

  1. Log in to the BRX Dashboard
  2. Navigate to Settings > API Keys
  3. Click “Generate New API Key”
  4. Copy your API key for use in your application

Your First BRK

Let’s create a simple BRK that generates a product description based on some input parameters.

1. Initialize the BRX Client

Create a new file called index.js (or index.ts for TypeScript) and add the following code:

2. Create a BRK

Now, let’s create a BRK for generating product descriptions:

3. Use the BRK

Now that we’ve created a BRK, let’s use it to generate a product description:

4. Run Your Code

Save your file and run it:
You should see a generated product description in the console output.

Next Steps

Now that you’ve created and used your first BRK, here are some next steps to explore:

Create Complex BRKs

Learn how to create BRKs with dependencies for more complex workflows

Explore the API

Dive into the BRX API for more advanced usage

Tool Calling

Integrate external tools and APIs with your BRX workflows

BRX Client

Learn more about the BRX Client and its capabilities

Troubleshooting

Common Issues

If you see an authentication error, make sure your API key is correct and has not expired. You can generate a new API key in the BRX Dashboard.
If your BRK fails to execute, check the error message for details. Common issues include:
  • Invalid input values
  • Exceeded token limits
  • Rate limiting
  • Dependency errors
If you’re experiencing network issues, check your internet connection and firewall settings. The BRX API requires outbound HTTPS connections.

Getting Help

If you’re still having issues, you can: