QUICKSTART

一次接入,连接多种模型。

创建账户,在控制台中创建 API 密钥。将密钥保存到服务端环境变量 TPOOL_API_KEY,并为账户配置可用额度。

创建 API 密钥

接口地址

本地开发使用 https://tpool-api.localhost/v1。正式服务规划地址为 https://api.tpool.dev/v1,当前开发预览尚未公开部署。

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["TPOOL_API_KEY"],
    base_url=os.environ["TPOOL_BASE_URL"],
)

response = client.responses.create(
    model="google/gemini-3.6-flash",
    input="你好,请用一句话介绍自己。",
    store=False,
)
print(response.output_text)

兼容现有 SDK

使用模型市场中的完整模型 ID。兼容能力以模型、渠道和接口组合为准。

协议路径说明
Chat CompletionsPOST /v1/chat/completionsJSON、SSE、工具调用
ResponsesPOST /v1/responses文本、工具与结构化输出
Anthropic MessagesPOST /v1/messages原生消息、SSE 与工具
模型目录GET /v1/models该密钥可用的模型
ImagesPOST /v1/images/generations按模型声明提供

Vercel AI SDK 可通过 @ai-sdk/openai 自定义 baseURL 使用 Responses;Chat 调用显式使用 provider.chat(modelId)。Vercel 原生 Gateway Provider 的独立传输协议仍在适配中。

供应商与故障切换

同一模型可由多个渠道提供。网关在已授权的可用渠道内按配置优先级、权重与健康状态选择,失败按策略尝试备用渠道。返回的请求 ID 可用于用量对账。跨模型替换需要明确配置。

Vercel 风格的 providerOptions.gateway 参数将在适配验证后逐项公布。当前使用控制台中已配置的同模型渠道策略。

图片与异步任务

图片接口返回完整图片结果。GPT Image 2 使用 size: "auto",对应 1K 方图并保留上游原始尺寸,当前实测为 1254×1254;FLUX.1 Schnell 使用 size: "1024x1024",固定四步、单张。各模型按模型详情中的每张价格结算。

异步供应商通过任务插件执行,使用 POST /v1/tasks/{pluginKey} 提交、GET /v1/tasks/{taskId} 查询,并在工作台的“生成任务”查看交付进度。当前插件为 tpool-apimart-image 与 tpool-runware-image。

长任务被接受后请保留任务 ID。停止本地等待后继续查询原任务,避免重复提交造成额外费用。每个插件的模型、参数、尺寸和计费单位都需要单独匹配。

用量、费用与错误

控制台价格统一使用 USD。密钥预算与账户余额共同限制调用。输入、输出、缓存及媒体等维度按网关计价配置扣费,用量页展示实际调用记录。

状态处理方式
400检查模型、参数与规格
401 / 403检查密钥、账户和模型权限
402 / 额度不足检查账户余额与密钥预算
429降低并发,按 Retry-After 重试
5xx保留请求 ID,检查上游与任务状态

请在服务端保管 API 密钥。浏览器调试台使用登录会话或本次选定的密钥,不会将密钥写入本地存储。