TransBridge API 文档

March 5, 2025 · View on GitHub

TransBridge 提供以下 API 接口:

翻译接口(DeepL 兼容)

请求

POST /v2/translate

请求头

名称必填描述
AuthorizationBearer 认证,格式为 Bearer YOUR_API_KEY
Content-Type固定为 application/json

请求体

{
  "text": "Hello world",
  "source_lang": "EN",
  "target_lang": "ZH",
  "provider": "openai",
  "model": "gpt-3.5-turbo"
}
参数类型必填描述
text字符串要翻译的文本
source_lang字符串源语言代码,例如 "EN", "ZH"
target_lang字符串目标语言代码,例如 "EN", "ZH"
provider字符串指定服务提供商,不填则随机选择
model字符串指定模型名称,不填则随机选择

支持的语言代码

代码语言
EN英语
ZH中文
JA日语
KO韩语
ES西班牙语
FR法语
DE德语
IT意大利语
RU俄语
PT葡萄牙语
NL荷兰语
PL波兰语
...其他语言

响应

{
  "code": 200,
  "data": "你好世界",
  "source_lang": "EN",
  "target_lang": "ZH"
}
字段类型描述
code数字状态码,200 表示成功
data字符串翻译后的文本
source_lang字符串源语言代码
target_lang字符串目标语言代码

错误响应

{
  "code": 401,
  "data": "Invalid API key"
}
状态码描述
400请求参数错误
401未授权(API 密钥无效)
500服务器内部错误

示例

cURL

curl -X POST "http://localhost:8080/v2/translate" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello world",
    "source_lang": "EN",
    "target_lang": "ZH"
  }'

Python

import requests

url = "http://localhost:8080/v2/translate"
headers = {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
}
data = {
    "text": "Hello world",
    "source_lang": "EN",
    "target_lang": "ZH"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

JavaScript

fetch("http://localhost:8080/v2/translate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    text: "Hello world",
    source_lang: "EN",
    target_lang: "ZH"
  })
})
.then(response => response.json())
.then(data => console.log(data));

OpenAI 兼容接口

TransBridge 还提供与 OpenAI API 兼容的接口,可以直接替代 OpenAI 的聊天完成接口。

请求

POST /v1/chat/completions

请求头

名称必填描述
AuthorizationBearer 认证,格式为 Bearer YOUR_API_KEY
Content-Type固定为 application/json

请求体

{
  "model": "openai/gpt-3.5-turbo",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "temperature": 0.7,
  "max_tokens": 100
}
参数类型必填描述
model字符串模型名称,格式为 "provider/model"
messages数组消息数组,包含多个消息对象
temperature浮点数温度参数,控制生成文本的随机性
max_tokens整数最大输出 token 数量

响应

响应格式与 OpenAI API 保持一致:

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677858242,
  "model": "openai/gpt-3.5-turbo",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ]
}

健康检查接口

请求

GET /health

响应

OK

状态码 200 表示服务正常运行。