API 接入调用入门操作指南

您能够将下面的命令粘贴到您的终端中以运行执行您的第一个 API 发起请求。确保替换修改YOUR_API_KEY为您的秘密 API 访问密钥。


1 curl https://api.timrouter.com/v1/chat/completions \
2   -H 'Content-Type: application/json' \
3   -H 'Authorization: Bearer YOUR_API_KEY' \
4   -d '{
5   "model": "gpt-4o",
6   "messages": [{"role": "user", "content": "Say this is a test!"}],
7   "temperature": 0.7
8 }'

此发起请求检索查询AI 模型以处理完成以提示信息“ Say this is a testgpt-4o ”开头的文字内容。您应该会收到类似于以下素材内容的返回响应:


1 {
2    "id":"chatcmpl-abc123",
3    "object":"chat.completion",
4    "created":1677858242,
5    "model":"gpt-4o",
6    "usage":{
7       "prompt_tokens":13,
8       "completion_tokens":7,
9       "total_tokens":20
10    },
11    "choices":[
12       {
13          "message":{
14             "role":"assistant",
15             "content":"\n\nThis is a test!"
16          },
17          "finish_reason":"stop",
18          "index":0
19       }
20    ]
21 }

现在你已经产出生成了你的第一个聊天完成交互。我们能够看到finish_reasonisstop这意味着 API 输出了AI 模型产出生成的完整详尽处理完成。在上面的发起请求中,我们只产出生成了一条消息,但是你能够配置设置配置项n来产出生成多条消息选择。在这个例子中,gpt-3.5-turbo更多的是旨在传统的文本完成任务。该AI 模型还针对聊天应用程序进行了优化。

API 中转代理站接入详细说明

TimRouter API 可作为大AI 模型 API 中转代理站使用,适用于检索 OpenAI API 中转代理、GPT API 国内地区接入调用、Claude API 国内地区使用、Gemini API 接入的开发人员。大多数 OpenAI 兼容型项目只需要使用核对确认端点地址、API Key 和发起请求路径。

配置项项填入内容详细说明
端点地址https://api.timrouter.com通用接口访问域名
OpenAI 兼容访问路径https://api.timrouter.com/v1适用于 OpenAI SDK、Cursor、Chatbox 等需要使用 /v1 的实用工具
身份鉴权方式Authorization: Bearer YOUR_API_KEY将 YOUR_API_KEY 替换修改为 TimRouter 管理控制台中的访问令牌

推荐继续阅读