身份验证
您可以使用 OpenRoute AI API 密钥来支付模型费用。
我们的 API 使用 Bearer 令牌对请求进行身份验证。这允许您直接使用 curl
或 OpenAI SDK 与 OpenRoute AI 交互。
OpenRoute AI 上的 API 密钥比直接用于模型 API 的密钥更强大。
它们允许用户为应用程序设置信用额度,并且可以在 OAuth 流程中使用。
使用 API 密钥
要使用 API 密钥,请首先创建您的密钥。为其命名,您可以选择性地设置信用额度。
如果您直接调用 OpenRoute AI API,请将 Authorization
标头设置为带有您 API 密钥的 Bearer 令牌。
如果您使用 OpenAI TypeScript SDK,请将 api_base
设置为 https://api.openroute.cn/v1
,并将 apiKey
设置为您的 API 密钥。
fetch('https://api.openroute.cn/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/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/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].message
curl https://api.openroute.cn/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!"}
]
}'
要使用 Python 进行流式传输,请查看 OpenAI 的这个示例。
如果您的密钥已泄露
您必须保护您的 API 密钥,永远不要将它们提交到公共存储库中。
OpenRoute AI 是 GitHub 秘密扫描合作伙伴,并具有其他检测泄露密钥的方法。如果我们确定您的密钥已被泄露,您将收到电子邮件通知。
如果您收到此类通知或怀疑您的密钥已泄露,请立即访问您的密钥设置页面删除泄露的密钥并创建新密钥。
强烈建议使用环境变量并将密钥排除在代码库之外。
Last updated on