Overview

Quickstart

Get up and running with the Rightbrain API in minutes.

What is Rightbrain?

Rightbrain provides APIs to rapidly prototype, deploy, and scale Generative AI features. Define tasks using natural language, choose your models, and get auto-scaling API endpoints that integrate seamlessly into your workflows.

Are you an AI Agent?

This documentation site provides machine-readable summaries to help you understand our API:

  • /llms.txt: A concise overview of the documentation structure.
  • /llms-full.txt: The complete documentation content, including the API reference, optimized for LLM consumption.

See the AI Agent Guide for more details.

Quickstart Guide

Follow these steps to start using the Rightbrain API:

1

Create an API Client

To interact with the API, you first need API credentials. You can create these in the Rightbrain dashboard:

  1. Navigate to the API Clients settings page.
  2. Click “Create Client”.
  3. Fill in the details:
    • Client name: A descriptive name for your application (e.g., “My Web App”, “Backend Processor”).
    • Description: (Optional) Briefly describe what the client is used for.
    • Grant types: Select the OAuth 2.0 flow(s) your application will use. For this quickstart, we’ll use Client Credentials, which is suitable for server-to-server interactions or scripts.
      • Choose Client Credentials for backend services or scripts.
      • Choose Authorization Code (usually with PKCE) for web or mobile apps where a user logs in.
      • You can select multiple grant types if needed.
  4. Click Save.
  5. Important: Your Client Secret will be displayed only once. Copy it immediately and store it securely alongside your Client ID. You will need both for authentication.

For a detailed explanation of which grant type to choose, see the Authentication Overview.

2

Obtain an Access Token (using Client Credentials)

Now, use your Client ID and Client Secret to get a temporary access token from the Rightbrain token endpoint. This example uses curl and the Client Credentials flow.

  • Token Endpoint URL: https://oauth.rightbrain.ai/oauth2/token
Get Access Token
$# Replace with your actual Client ID and Secret from Step 1
>CLIENT_ID="<YOUR_CLIENT_ID>"
>CLIENT_SECRET="<YOUR_CLIENT_SECRET>"
>
># Request the token using Client Credentials grant
>TOKEN=$(curl -s -u "$CLIENT_ID:$CLIENT_SECRET" \
>      -d "grant_type=client_credentials" \
>      https://oauth.rightbrain.ai/oauth2/token | jq -r '.access_token')
>
># Check if the token was obtained (optional)
># echo "Token: $TOKEN"

This command authenticates using your credentials (-u) and requests a token (-d grant_type=...). The access token is extracted from the JSON response using jq and stored in the TOKEN variable.

3

Make Your First API Call

With the access token stored in the TOKEN variable, you can now make authenticated requests to the Rightbrain API. Include the token in the Authorization header using the Bearer scheme.

Replace <API_ENDPOINT_URL> with the actual endpoint you want to call (e.g., from the API Reference).

Example Authenticated API Call
$# Ensure TOKEN variable is set from Step 2
>
>curl -X POST \
>  -H "Authorization: Bearer ${TOKEN}" \
>  -H "Content-Type: application/json" \
>  -d '{"parameter": "value"}' \
>  <API_ENDPOINT_URL>

For more details on how the Authorization header works, see Calling the API.

Next Steps

You’ve successfully authenticated and made a call! Now you can: