Authentication
You can cover model costs with OpenRoute API keys.
Our API authenticates requests using Bearer tokens. This allows you to use curl or the OpenAI SDK directly with OpenRoute.
API keys on OpenRoute are more powerful than keys used directly for model APIs.
They allow users to set credit limits for apps, and they can be used in OAuth flows.
Using an API key
To use an API key, first create your key. Give it a name and you can optionally set a credit limit.
If you're calling the OpenRoute API directly, set the Authorization header to a Bearer token with your API key.
If you're using the OpenAI Typescript SDK, set the api_base to https://openroute.cn/api/v1 and the apiKey to your API key.
fetch('https://openroute.cn/api/v1/chat/completions', {
method: 'POST',
headers: {
Authorization: 'Bearer <OPENROUTE_API_KEY>',
'HTTP-Referer': '<YOUR_SITE_URL>', // Optional. Site URL for rankings on openroute.cn.
'X-Title': '<YOUR_SITE_NAME>', // Optional. Site title for rankings on openroute.cn.
'Content-Type': 'application/json',
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'user',
content: 'What is the meaning of life?',
},
],
}),
});import OpenAI from 'openai';
const openai = new OpenAI({
baseURL: 'https://api.openroute.cn/api/v1',
apiKey: '<OPENROUTE_API_KEY>',
defaultHeaders: {
'HTTP-Referer': '<YOUR_SITE_URL>', // Optional. Site URL for rankings on openroute.cn.
'X-Title': '<YOUR_SITE_NAME>', // Optional. Site title for rankings on openroute.cn.
},
});
async function main() {
const completion = await openai.chat.completions.create({
model: 'openai/gpt-4o',
messages: [{ role: 'user', content: 'Say this is a test' }],
});
console.log(completion.choices[0].message);
}
main();import openai
openai.api_base = "https://api.openroute.cn/api/v1"
openai.api_key = "<OPENROUTE_API_KEY>"
response = openai.ChatCompletion.create(
model="openai/gpt-4o",
messages=[...],
headers={
"HTTP-Referer": "<YOUR_SITE_URL>", # Optional. Site URL for rankings on openroute.cn.
"X-Title": "<YOUR_SITE_NAME>", # Optional. Site title for rankings on openroute.cn.
},
)
reply = response.choices[0].messagecurl https://api.openroute.cn/api/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENROUTE_API_KEY" \
-d '{
"model": "openai/gpt-4o",
"messages": [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello!"}
]
}'To stream with Python, see this example from OpenAI.
If your key has been exposed
You must protect your API keys and never commit them to public repositories.
OpenRoute is a GitHub secret scanning partner, and has other methods to detect exposed keys. If we determine that your key has been compromised, you will receive an email notification.
If you receive such a notification or suspect your key has been exposed, immediately visit your key settings page to delete the compromised key and create a new one.
Using environment variables and keeping keys out of your codebase is strongly recommended.
Last updated on