Quickstart

1. Get Your API Key

Go to the Routeway Dashboard and log in.

Open the API Keys section.
Click Create API Key.
Copy your key and keep it secure.

New to APIs? You don’t need any code to get started — just grab a key and paste it into your chat app’s settings. See our Integrations Guide or Roleplay Platforms Guide for setup steps.

Never share your API key or commit it to version control. Anyone with your key can access your billing and use your quota.

2. Configure Your Environment Variable

Store your API key as an environment variable to authenticate SDKs and client libraries automatically.

Linux/macOS
Windows (CMD)
Windows (PowerShell)

export ROUTEWAY_API_KEY="your_key_here"

set ROUTEWAY_API_KEY="your_key_here"

$env:ROUTEWAY_API_KEY="your_key_here"

3. Make Your First Request

Since Routeway is fully compatible with the OpenAI API, you can use the official OpenAI SDKs or raw HTTP requests.

Python
Node.js
cURL

Install the official OpenAI Python library:

pip install openai

Create a new file and run the following script:

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://api.routeway.ai/v1",
    api_key=os.getenv("ROUTEWAY_API_KEY")
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[
        {"role": "user", "content": "Write a short story about a robot and a cat."}
    ]
)

print(response.choices[0].message.content)

Install the official OpenAI Node.js library:

npm install openai

Create a new file and run the following script:

const { OpenAI } = require("openai");

const client = new OpenAI({
  base_url: "https://api.routeway.ai/v1",
  api_key: process.env.ROUTEWAY_API_KEY,
});

async function main() {
  const response = await client.chat.completions.create({
    model: "gpt-4o-mini",
    messages: [
      { role: "user", content: "Write a short story about a robot and a cat." }
    ]
  });

  console.log(response.choices[0].message.content);
}

main().catch(console.error);

Send a raw HTTP request directly using cURL:

curl https://api.routeway.ai/v1/chat/completions \
  -H "Authorization: Bearer $ROUTEWAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {"role": "user", "content": "Write a short story about a robot and a cat."}
    ]
  }'

Get Started

Platform Details

Help & Resources

Core Concepts

Account Management

Guides