> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runbridge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Start with RunBridge AI: create an API key and make your first call

> Start with RunBridge AI by creating an API key, setting the base URL, and sending your first curl, Python, or Node.js API request.

## Create an account and API key

Create a RunBridge AI account and API key before you call the API.

<Steps>
  <Step title="Sign in or create an account">
    Open the [RunBridge AI login page](https://runbridge.ai/console/login). Continue with Google, continue with GitHub, or enter your email or username. If you do not have an account, complete account creation from this page.
  </Step>

  <Step title="Open API keys">
    After you sign in, open the [API key page](https://runbridge.ai/console/token). You can also select **API Keys** in the dashboard sidebar.
  </Step>

  <Step title="Create an API key">
    Click **Create API Key**, enter a clear name such as `local-test`, and keep **Unlimited Quota** enabled for a first test unless you want to set a spending cap. Click **Create**.
  </Step>

  <Step title="Copy the API key">
    Click the copy button in the **Key** column. Store the copied key in a server-side environment variable or a local `.env` file. Do not paste a real API key into public repositories, frontend code, screenshots, or support tickets.
  </Step>
</Steps>

Request examples read `RUNBRIDGE_API_KEY` from your environment.

## Store your API key locally

For local testing, export your API key as an environment variable:

```bash theme={null}
read -rsp "RunBridge AI API key: " RUNBRIDGE_API_KEY
printf '\n'
export RUNBRIDGE_API_KEY
```

## Base URL

Use this base URL for OpenAI-compatible SDKs and API calls:

```text theme={null}
https://api.runbridge.ai/v1
```

## 30-second switch from OpenAI

After you have a RunBridge AI API key, use this two-setting diff when you switch an OpenAI SDK client to RunBridge AI:

```diff theme={null}
- base_url="https://api.openai.com/v1"
- api_key=os.environ["OPENAI_API_KEY"]
+ base_url="https://api.runbridge.ai/v1"
+ api_key=os.environ["RUNBRIDGE_API_KEY"]
```

RunBridge AI uses OpenAI-compatible request formats for text and GPT Image workflows. If your app already uses the OpenAI SDK, start by changing the base URL and API key.

## Make your first call

After you set `RUNBRIDGE_API_KEY` in your environment, replace `your-model-id` with a current model ID from the [Models page](/overview/models).

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.runbridge.ai/v1/chat/completions \
    -H "Authorization: Bearer $RUNBRIDGE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "your-model-id",
      "messages": [
        {
          "role": "user",
          "content": "Write a one-sentence bedtime story."
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import os
  from openai import OpenAI

  client = OpenAI(
      api_key=os.environ["RUNBRIDGE_API_KEY"],
      base_url="https://api.runbridge.ai/v1",
  )

  completion = client.chat.completions.create(
      model="your-model-id",
      messages=[
          {
              "role": "user",
              "content": "Write a one-sentence bedtime story.",
          }
      ],
  )

  print(completion.choices[0].message.content)
  ```

  ```javascript Node.js theme={null}
  import OpenAI from "openai";

  const client = new OpenAI({
    apiKey: process.env.RUNBRIDGE_API_KEY,
    baseURL: "https://api.runbridge.ai/v1",
  });

  const completion = await client.chat.completions.create({
    model: "your-model-id",
    messages: [
      {
        role: "user",
        content: "Write a one-sentence bedtime story.",
      },
    ],
  });

  console.log(completion.choices[0].message.content);
  ```
</CodeGroup>

## Pick a model

Choose a model ID from the [Models page](/overview/models), then pass that value in the `model` field.

| Goal | Where to start |
| - | - |
| Chat or general text | Use a GPT, Claude, Gemini, DeepSeek, or other chat model with [Chat Completions](/api/text/chat). |
| Coding and reasoning | Use a coding or reasoning model with [Responses](/api/text/responses) when the model requires the Responses API. |
| Image generation and editing | Choose GPT Image, Google Nano Banana, or Grok from the [Image APIs](/api/image). |

## What is next

* For request failures, see [Error Codes & Handling](/errors/error-codes-handling).
* For retry guidance, see [how to handle rate limits](/api/text/chat#how-to-handle-rate-limits).
* For text request formats, see [Text and chat APIs](/api/text). For GPT Image, Google Nano Banana, and Grok, see [Image APIs](/api/image).
* For help, see the [Help Center](/support/help-center) or contact [RunBridge AI support](https://runbridge.ai/support/).

## FAQ

<AccordionGroup>
  <Accordion title="How do I create a RunBridge AI account?">
    Open the [RunBridge AI login page](https://runbridge.ai/console/login), then continue with Google, continue with GitHub, or enter your email or username. If you do not have an account, complete account creation from the same page.
  </Accordion>

  <Accordion title="How do I get a RunBridge AI API key?">
    Open the [API key page](https://runbridge.ai/console/token) in the RunBridge AI dashboard, click **Create API Key**, enter a name, click **Create**, and copy the generated API key. Use `$RUNBRIDGE_API_KEY` in examples instead of a real API key.
  </Accordion>

  <Accordion title="Where should I store my API key?">
    Store your API key in a server-side environment variable or a local `.env` file. Do not commit it to public repositories, paste it into frontend code, include it in screenshots, or send it in support tickets.
  </Accordion>

  <Accordion title="What is the RunBridge AI base URL for API calls?">
    Use `https://api.runbridge.ai/v1` for OpenAI-compatible SDKs and endpoints such as `/v1/chat/completions`.
  </Accordion>

  <Accordion title="Does RunBridge AI work with the OpenAI Python SDK?">
    Yes. Create an `OpenAI` client, set `api_key` to your RunBridge AI API key, and set `base_url` to `https://api.runbridge.ai/v1`.
  </Accordion>

  <Accordion title="How do I switch from OpenAI to RunBridge AI?">
    Change the base URL to `https://api.runbridge.ai/v1`, replace the API key with your RunBridge AI API key, and use a RunBridge AI model ID from the [Models page](/overview/models).
  </Accordion>

  <Accordion title="Which model ID should I use first?">
    Choose the model ID by use case. Start from the [Models page](/overview/models), then select a text or image model that matches the API page that you plan to call.
  </Accordion>

  <Accordion title="Which programming languages does RunBridge AI support?">
    RunBridge AI works with any programming language that can send HTTPS requests. Start with the curl, Python, and Node.js examples on this page, or use an OpenAI-compatible SDK that lets you override the base URL.
  </Accordion>

  <Accordion title="Does RunBridge AI offer a free trial or free API key?">
    You can create a RunBridge AI API key from the dashboard. To check free trial availability, free trial credits, and billing details, see the [RunBridge AI pricing page](https://runbridge.ai/pricing/).
  </Accordion>
</AccordionGroup>

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "HowTo",
        "name": "RunBridge AI quickstart: Create an API key and make your first call",
        "description": "RunBridge AI quickstart for first-time users: sign in, create an API key, copy the key, set the base URL, and make your first curl, Python, or Node.js API call.",
        "step": [
          {
            "@type": "HowToStep",
            "@id": "https://runbridge.mintlify.site/overview/quick-start#sign-in-or-create-an-account",
            "name": "Sign in or create an account",
            "text": "Open https://runbridge.ai/console/login and continue with Google, GitHub, or email."
          },
          {
            "@type": "HowToStep",
            "@id": "https://runbridge.mintlify.site/overview/quick-start#open-api-keys",
            "name": "Open API keys",
            "text": "After signing in, open https://runbridge.ai/console/token or select API Keys in the dashboard sidebar."
          },
          {
            "@type": "HowToStep",
            "@id": "https://runbridge.mintlify.site/overview/quick-start#create-an-api-key",
            "name": "Create an API key",
            "text": "Click Create API Key, enter a name, choose the quota setting, and click Create."
          },
          {
            "@type": "HowToStep",
            "@id": "https://runbridge.mintlify.site/overview/quick-start#copy-the-api-key",
            "name": "Copy the API key",
            "text": "Click the copy button in the Key column and store the key in a server-side environment variable or local .env file."
          },
          {
            "@type": "HowToStep",
            "name": "Set the base URL",
            "text": "Use https://api.runbridge.ai/v1 as the base URL for OpenAI-compatible SDKs and API calls."
          },
          {
            "@type": "HowToStep",
            "name": "Make your first call",
            "text": "Call /v1/chat/completions with curl, Python, or Node.js, and replace your-model-id with a current model ID from the RunBridge AI Models page."
          }
        ]
      },
      {
        "@type": "FAQPage",
        "mainEntity": [
          {
            "@type": "Question",
            "name": "How do I create a RunBridge AI account?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Open the RunBridge AI login page and continue with Google, GitHub, or email. If you do not have an account, complete account creation from the same page."
            }
          },
          {
            "@type": "Question",
            "name": "How do I get a RunBridge AI API key?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Open the API key page in the RunBridge AI dashboard, click Create API Key, enter a name, click Create, and copy the generated API key."
            }
          },
          {
            "@type": "Question",
            "name": "Where should I store my API key?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Store your API key in a server-side environment variable or a local .env file. Do not commit it to public repositories, paste it into frontend code, include it in screenshots, or send it in support tickets."
            }
          },
          {
            "@type": "Question",
            "name": "What is the RunBridge AI base URL for API calls?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Use https://api.runbridge.ai/v1 for OpenAI-compatible SDKs and endpoints."
            }
          },
          {
            "@type": "Question",
            "name": "Does RunBridge AI work with the OpenAI Python SDK?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Yes. Create an OpenAI client, set api_key to your RunBridge AI API key, and set base_url to https://api.runbridge.ai/v1."
            }
          },
          {
            "@type": "Question",
            "name": "How do I switch from OpenAI to RunBridge AI?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Change the base URL to https://api.runbridge.ai/v1, replace the API key with your RunBridge AI API key, and use a RunBridge AI model ID from the Models page."
            }
          },
          {
            "@type": "Question",
            "name": "Which model ID should I use first?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "Choose the model ID by use case. Start from the Models page, then select a text or image model that matches the API page that you plan to call."
            }
          },
          {
            "@type": "Question",
            "name": "Which programming languages does RunBridge AI support?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "RunBridge AI works with any programming language that can send HTTPS requests. Start with the curl, Python, and Node.js examples, or use an OpenAI-compatible SDK that lets you override the base URL."
            }
          },
          {
            "@type": "Question",
            "name": "Does RunBridge AI offer a free trial or free API key?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "You can create a RunBridge AI API key from the dashboard. To check free trial availability, free trial credits, and billing details, see the RunBridge AI pricing page and About Pricing page."
            }
          }
        ]
      }
    ]
    }
    `}
</script>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.