OpenAI SDK

概述

TopRouter 为您提供稳定、高效的 OpenAI SDK 访问服务，让您能够无缝集成强大的 AI 能力到您的应用中。

获取 API 密钥

开始使用前，您需要获取 TopRouter 的 API 密钥：

1. 访问 TopRouter 官网 并完成注册
2. 登录后点击页面右上角的用户菜单，选择"密钥管理"
3. 点击"生成新密钥"按钮，复制生成的 API 密钥

安全提示

请妥善保管您的 API 密钥，切勿在公共代码仓库、前端代码或任何公开场合暴露。建议使用环境变量的方式进行管理。

功能特性

TopRouter 完全兼容 OpenAI SDK 标准，支持以下核心功能：

• 对话补全（Chat Completions）：支持 GPT-5、GPT-OSS 等系列模型
• Responses API：OpenAI 最新一代 API，合并了 Chat Completions 与 Assistants API 的核心能力
• 视觉理解（Vision）：处理图像相关的 AI 任务
• 函数调用（Function Calling）：让模型调用自定义函数
• 流式输出（Streaming）：实时获取模型响应

更多关于请求参数和响应格式的详细信息，请参阅 OpenAI 官方文档。

快速开始

TopRouter 完全兼容 OpenAI 官方客户端库。如果您已经在使用 OpenAI SDK，只需修改两处配置即可无缝迁移：

1. 将 API Key 替换为 TopRouter 的密钥
2. 将 Base URL 设置为 TopRouter 的服务地址

Python 集成示例

首先安装 OpenAI Python 库：

pip install openai

然后使用以下代码调用 API：

import os
from openai import OpenAI

# 初始化客户端
client = OpenAI(
    api_key=os.environ.get("TOPROUTER_API_KEY"),  # 从环境变量读取密钥
    base_url="https://api.toprouter.ai/api/openai/v1",  # TopRouter 服务地址
)

# 发起对话请求
response = client.chat.completions.create(
    model="tp.gpt-5-chat",
    messages=[
        {"role": "system", "content": "你是一个有帮助的AI助手。"},
        {"role": "user", "content": "请解释什么是机器学习？"}
    ]
)

# 输出模型回复
print(response.choices[0].message.content)

TypeScript/Node.js 集成示例

首先安装 OpenAI TypeScript 库：

npm install openai
# 或使用 yarn
yarn add openai

然后使用以下代码调用 API：

import OpenAI from "openai";

// 初始化客户端
const client = new OpenAI({
    apiKey: process.env.TOPROUTER_API_KEY,  // 从环境变量读取密钥
    baseURL: "https://api.toprouter.ai/api/openai/v1",  // TopRouter 服务地址
});

// 发起对话请求
async function chat() {
    const response = await client.chat.completions.create({
        model: "tp.gpt-5-chat",
        messages: [
            { role: "system", content: "你是一个有帮助的AI助手。" },
            { role: "user", content: "请解释什么是机器学习？" }
        ],
    });
    
    console.log(response.choices[0].message.content);
}

chat();

Responses API

OpenAI Responses API 是 2025 年推出的新一代 API，它将 Chat Completions 与 Assistants API 的能力整合为统一接口，特别适合构建智能体（Agent）和复杂的多轮对话应用。

Responses API vs Chat Completions API

特性	Chat Completions	Responses API
端点	client.chat.completions.create	client.responses.create
输入格式	messages 数组	input 字段 + instructions 系统提示
输出格式	response.choices[0].message.content	response.output_text
状态管理	客户端手动维护历史	服务端通过 previous_response_id 自动管理
内置工具	需手动配置 Function Calling	原生支持网络搜索、文件检索等工具

TopRouter 支持 OpenAI Responses API，服务地址为：

https://api.toprouter.ai/api/openai/v1/responses

Python 集成示例

import os
from openai import OpenAI

# 初始化客户端
client = OpenAI(
    api_key=os.environ.get("TOPROUTER_API_KEY"),  # 从环境变量读取密钥
    base_url="https://api.toprouter.ai/api/openai/v1",  # TopRouter 服务地址
)

# 使用 Responses API 发起请求
response = client.responses.create(
    model="tp.gpt-5-chat",
    instructions="你是一个有帮助的AI助手。",  # 系统提示
    input="请解释什么是机器学习？"            # 用户输入
)

# 直接获取文本输出
print(response.output_text)

TypeScript/Node.js 集成示例

import OpenAI from "openai";

// 初始化客户端
const client = new OpenAI({
    apiKey: process.env.TOPROUTER_API_KEY,  // 从环境变量读取密钥
    baseURL: "https://api.toprouter.ai/api/openai/v1",  // TopRouter 服务地址
});

// 使用 Responses API 发起请求
async function chat() {
    const response = await client.responses.create({
        model: "tp.gpt-5-chat",
        instructions: "你是一个有帮助的AI助手。",  // 系统提示
        input: "请解释什么是机器学习？",            // 用户输入
    });
    
    console.log(response.output_text);
}

chat();

环境变量配置

为了安全管理 API 密钥，建议使用环境变量：

Linux/macOS：

export TOPROUTER_API_KEY="your-api-key-here"

Windows PowerShell：

$env:TOPROUTER_API_KEY="your-api-key-here"

使用 .env 文件（推荐）：

在项目根目录创建 .env 文件：

TOPROUTER_API_KEY=your-api-key-here

然后使用 python-dotenv（Python）或 dotenv（Node.js）加载环境变量。

下一步

• 查看 快速入门指南 了解更多使用场景
• 探索 函数调用功能 实现更复杂的交互
• 了解 结构化输出 获取符合 JSON Schema 的模型响应
• 了解 图像生成功能 创建 AI 艺术作品