Skip to content

快速入门

Trinity 当前仅提供 OpenAI 兼容的 HTTP API 接入:向网关发送标准 REST 请求(如 POST /v1/chat/completions),在请求头携带 API Key 即可调用平台提供的模型。

重要 · 模型与密钥

  • API Key 前缀一般为 xh-...(控制台创建后完整复制)。
  • 请求里的 model模型 ID(与 模型广场 列表一致),例如 doubao-seed-1-6-thinking-agent-preview。勿填写平台未提供的模型名。
  • 请勿在公共仓库、前端 bundle 或日志中暴露完整密钥。

有关流式、追踪/结算头与错误处理,见 流式 SSEAPI 概述错误码


1. 创建 API 密钥

  1. 打开 Trinity 控制台 · API 密钥
  2. 进入 API 密钥,创建密钥并妥善保存(仅展示一次)。

也可参阅 管理 API 密钥


2. 配置接入地址与密钥

将网关 base_url 与密钥写入环境变量(生产基址示例如下;如使用专属部署,请以你的交付信息为准):

bash
export TRINITY_API_KEY="xh-..."
export TRINITY_BASE_URL="https://api.trinitydesk.ai/v1"
typescript
process.env.TRINITY_API_KEY = "xh-...";
process.env.TRINITY_BASE_URL = "https://api.trinitydesk.ai/v1";
python
import os
os.environ["TRINITY_API_KEY"] = "xh-..."
os.environ["TRINITY_BASE_URL"] = "https://api.trinitydesk.ai/v1"

3. 发送首次 API 请求

请求体与 OpenAI Chat Completions 保持一致;可选传入追踪/结算头(见 API 概述)。

bash
curl -sS "${TRINITY_BASE_URL}/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${TRINITY_API_KEY}" \
  -H "X-Request-Id: trace-demo-001" \
  -H "X-Idempotency-Key: settle-demo-001" \
  -d '{
    "model": "doubao-seed-1-6-thinking-agent-preview",
    "messages": [{ "role": "user", "content": "你好" }]
  }'
typescript
const res = await fetch(`${process.env.TRINITY_BASE_URL}/chat/completions`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer ${process.env.TRINITY_API_KEY}`,
    "X-Request-Id": crypto.randomUUID(),
    "X-Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    model: "doubao-seed-1-6-thinking-agent-preview",
    messages: [{ role: "user", content: "你好" }],
  }),
});
const data = await res.json();
console.log(data.choices[0]?.message?.content);
python
import json
import os
import requests

response = requests.post(
    url=f"{os.environ['TRINITY_BASE_URL']}/chat/completions",
    headers={
        "Authorization": f"Bearer {os.environ['TRINITY_API_KEY']}",
        "Content-Type": "application/json",
        "X-Request-Id": "trace-demo-001",
        "X-Idempotency-Key": "settle-demo-001",
    },
    data=json.dumps({
        "model": "doubao-seed-1-6-thinking-agent-preview",
        "messages": [{"role": "user", "content": "你好"}],
    }),
)
print(response.json()["choices"][0]["message"]["content"])

流式输出在请求体中设置 "stream": true,响应为 SSE,详见 流式 SSE


模型标识

请求体里的 model 必须填 Trinity 的模型 ID(英文 slug,如 doubao-seed-1-6-thinking-agent-preview),不是页面上的展示名,也不要直接照搬其他平台文档里的写法,除非该字符串出现在你账号的可用列表中。

客户如何获取模型 ID

以你登录账号实际看到的列表为准(与套餐、权限、区域有关)。

方式操作说明
模型广场(推荐)模型广场 复制目标模型的 模型 ID,填入 "model"(需先登录控制台,可从 API 密钥页 进入)当前获取模型 ID 的方式

INFO

在 IDE / Agent 工具(Cursor 等)里手填或下拉的名称也应与模型广场中的 ID 一致,详见 应用场景 · 编程工具

model 不在可用列表中,网关会返回模型不存在类错误,见 错误与调试

示例 ID(格式参考,调用前请核对列表)

  • 生文:doubao-seed-1-6-thinking-agent-previewgpt-4o
  • 生图:hunyuan-imagePOST /v1/chat/completions + image_config,见 图像生成 API
  • 生视频:tencent/kling-2.6POST /v1/video/generations

更多说明见 API 概述 · 模型 ID

下一步

能力指南API
生文流式输出创建对话补全
生图图片生成图像生成
生视频视频生成创建视频任务
编程工具应用场景Cursor / Claude Code / Codex CLI

© Trinity AI