Skip to content

RightbrainAI/bruno

Repository files navigation

Rightbrain API Collection

Fetch in Bruno

This repository contains a Bruno collection for interacting with the Rightbrain API. Rightbrain allows you to build and deploy LLM features rapidly by turning prompts into production-ready APIs.

Getting Started

Follow these steps to get the collection running, whether you cloned the repository or used the "Fetch in Bruno" button.

Step 1: Install Bruno

  • If you haven't already, download and install the Bruno API client from www.usebruno.com.

Step 2: Load the Collection

  • Using Fetch Button: Clicking the "Fetch in Bruno" button above should automatically load the collection into Bruno.
  • Cloning Repository: If you cloned the repository, open Bruno, click "Open Collection", and select the folder where you cloned it.

Step 3: Configure Environment Variables (⚠️ Mandatory)

This is a crucial step required for all users, including those who used the Fetch button.

  1. Locate .env.example: Find this file within the collection folder.
    • If Cloned: It will be in the root directory you cloned.
    • If Fetched: Check the "Env & Vars" tab for the collection within Bruno.
  2. Create .env: Make a copy of .env.example and rename the copy to .env.
  3. Add Credentials: Open the .env file and fill in your Rightbrain API credentials:
    • New users: You can get these when onboarding to Rightbrain.
    • Existing users: Go to the API Client section in your Rightbrain dashboard, select or create a Client Credentials API client, and click "Copy all" to get the necessary values.

Step 4: Run Requests!

  • Select the Dynamic environment in the top-right dropdown in Bruno.
  • Choose a request from the collection panel on the left.
  • Click "Send".

Contributing

Contributions, issues, and feature requests are welcome!

Resources

Exporting Collection

Bruno allows you to export this collection for use in other tools or formats:

  • Postman: You can export the collection to a Postman format.
  • OpenAPI: Export to OpenAPI v3 specification.
  • Curl: Generate curl commands for individual requests.

Refer to the Bruno Export Documentation for detailed instructions on how to export.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published