Docs

GLOUTH LINK · API DOCS

一个 Base URL,
两种协议,所有模型

Glouth Link 是双协议兼容的 LLM 网关。同一个 Base URL 同时接受 Chat Completions / Responses 和 Messages 两种协议;同一把 API Key 可以驱动主流的对话 SDK、消息 SDK、以及各类 AI 命令行工具等任何兼容客户端。

BASE URL

https://www.glouth.com/link/v1

AUTH

Authorization: Bearer sk-glouth-...
# 或
x-api-key: sk-glouth-...

快速上手

三步:创建 Key设置 Base URL用熟悉的 SDK 调用。下面四种写法任选其一:

curl https://www.glouth.com/link/v1/chat/completions \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [{"role":"user","content":"Hello"}]
  }'

认证

支持两种认证方式,任选其一:

方式一:Bearer Token(Authorization 头)

Authorization: Bearer sk-glouth-XXXXXXXXXXXXXXXXXX

方式二:x-api-key 头

x-api-key: sk-glouth-XXXXXXXXXXXXXXXXXX

:Glouth Link 自动识别两种 header。若同时传,优先 Authorization。

Base URL 与协议

所有端点的 Base URL 是同一个:

https://www.glouth.com/link/v1

协议自动判定

  • 请求带 anthropic-versionx-api-key 头 → Messages 协议
  • 请求 body 含 system 字段、或 content block 数组 → Messages 协议
  • 其他情况 → Chat Completions 协议

所有端点

下面列表是当前支持的端点。点击跳详细参数。

模型一览

实时价格 → /link#pricing(从 DB 实时读)。
可用模型 → GET /models(按 Key 权限筛选)。

模型 key说明线路
gpt-5.5最新旗舰,推理最强,复杂任务首选标准线路
gpt-5.4主力旗舰模型,推理与代码标准线路
gpt-5.4-mini日常对话与轻量任务,性价比高标准线路
gpt-image-2图片生成与编辑标准线路
codex-*专线版,价格低 30%(走 /codex/* 端点)专线
POST/chat/completions

对话生成

OpenAI Chat Completions 兼容端点,接收聊天历史返回模型回复。支持流式、视觉、推理强度、函数调用。

参数

字段类型必填说明
modelstring必填模型 key,例如 gpt-5.4、gpt-5.5、codex-gpt-5.4。详见 GET /models。
messagesarray必填消息历史。每条 {role: "system|user|assistant|tool", content: string | content_blocks[]}。
max_tokensinteger可选生成上限 token,默认按模型上下文上限。
temperaturenumber可选采样温度,0–2。
top_pnumber可选核采样概率阈值。
streamboolean可选设为 true 走 SSE 流式返回。
stream_optionsobject可选设 {include_usage: true} 在最后一帧返回 usage。默认替你打开。
reasoning_effortstring可选推理强度:low / medium / high / xhigh(Glouth 扩展)。
toolsarray可选OpenAI 风格函数声明数组。
tool_choicestring|object可选auto(默认) / required / none / {type:"function", function:{name:"..."}}。
stopstring|array可选遇到匹配字符串则停止生成。

请求示例

curl https://www.glouth.com/link/v1/chat/completions \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "reasoning_effort": "medium",
    "messages": [
      {"role":"system","content":"You are a precise assistant."},
      {"role":"user","content":"What is 23 * 17?"}
    ]
  }'

响应示例

{
  "id": "chatcmpl_...",
  "object": "chat.completion",
  "model": "gpt-5.4",
  "choices": [{
    "index": 0,
    "message": {"role":"assistant","content":"391"},
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 34,
    "completion_tokens": 24,
    "total_tokens": 58,
    "prompt_tokens_details": {"cached_tokens": 0},
    "completion_tokens_details": {"reasoning_tokens": 17}
  }
}
:调用失败(5xx)会自动切换线路重试一次。仍失败响应里有详细错误,响应头 X-Glouth-Request-ID 可用于提工单。
POST/responses

Responses API

OpenAI 新版 Responses 端点,通过 input 字段提交内容,适合长上下文与会话状态托管类用法。所有 chat/completions 的特性同样适用。

参数

字段类型必填说明
modelstring必填模型 key。
inputstring|array必填提交内容。字符串或结构化 input items 数组。
instructionsstring可选系统指令,等价于 system 消息。
streamboolean可选SSE 流式开关。
reasoning_effortstring可选推理强度(同 /chat/completions)。
toolsarray可选Responses 风格的 tools 声明。

请求示例

curl https://www.glouth.com/link/v1/responses \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "input": "用一句话介绍 Glouth Link。"
  }'

响应示例

{
  "id": "resp_...",
  "object": "response",
  "output": [{"type":"message","content":[{"type":"output_text","text":"..."}]}],
  "usage": {"input_tokens": 12, "output_tokens": 21}
}
POST/messages

Anthropic Messages API

完全兼容 Anthropic /v1/messages 接口形态。请求头带 anthropic-version 或 x-api-key,或 body 含 system/content block 时,主站自动走 Anthropic 协议路径。

参数

字段类型必填说明
modelstring必填建议传 Glouth 模型 key(gpt-5.4 等)。若传 Claude 模型名会自动映射到等价 Glouth 模型;实际执行的是映射后的模型。
max_tokensinteger必填Anthropic 协议必填,生成上限 token。
messagesarray必填消息数组。Anthropic 风格 content block(type: text/image 等)。
systemstring|array可选系统提示词。
streamboolean可选流式开关。Glouth 输出标准 Anthropic SSE event(message_start / content_block_delta / message_stop 等)。
thinkingobject可选{type:"enabled", budget_tokens:N}。按预算自动映射 reasoning_effort:<2000=low / <8000=medium / <16000=high / ≥16000=xhigh。
toolsarray可选Anthropic 风格 tools(name/description/input_schema)。
tool_choiceobject可选{type:"auto|any|tool", name?:"..."}
stop_sequencesarray可选停止序列数组。

请求示例

curl https://www.glouth.com/link/v1/messages \
  -H "x-api-key: $GLOUTH_LINK_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-3-5-sonnet-20241022",
    "max_tokens": 1024,
    "thinking": {"type":"enabled","budget_tokens":4000},
    "messages": [
      {"role":"user","content":"What is 25*4?"}
    ]
  }'

响应示例

{
  "id": "msg_...",
  "type": "message",
  "role": "assistant",
  "model": "claude-3-5-sonnet-20241022",
  "content": [{"type":"text","text":"100"}],
  "stop_reason": "end_turn",
  "usage": {"input_tokens": 26, "output_tokens": 18}
}
:传入 Claude 系列模型名时,Glouth 按等效算力路由到 GPT 系模型(sonnet → gpt-5.4,haiku → gpt-5.4-mini),代码无需改动。计费按实际服务模型走,响应里 model 字段照旧返回你请求的名字。
POST/images/generations

图片生成

调用 gpt-image-2 模型从文本提示生成图片。响应中返回 b64_json 或 url。按请求计固定单价。

参数

字段类型必填说明
modelstring必填当前固定 gpt-image-2。
promptstring必填图片描述。
sizestring可选1024x1024 / 1024x1536 / 1536x1024。
ninteger可选生成数量,默认 1。
qualitystring可选low / medium / high。
response_formatstring可选b64_json 或 url。

请求示例

curl https://www.glouth.com/link/v1/images/generations \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "A minimalist green leaf on white background",
    "size": "1024x1024",
    "n": 1
  }'

响应示例

{
  "created": 1778561900,
  "data": [{
    "b64_json": "iVBORw0KGgoAAAA..."
  }]
}
:图片生成耗时 20–60s。高峰偶发 502 等几秒重试就好。
POST/images/edits

图片编辑

基于现有图片做编辑/重绘。输入图片以 base64 形式放入 JSON body(无需 multipart),与 prompt 一起提交。

参数

字段类型必填说明
modelstring必填gpt-image-2。
promptstring必填编辑描述。
image_b64 / image_data_urlstring必填原图。可用纯 base64 或完整 data URL。也支持 images_b64 数组传多图。
mask_b64string可选可选 mask,白色区域将被重绘。
sizestring可选同 /images/generations。
ninteger可选生成数量。

请求示例

curl https://www.glouth.com/link/v1/images/edits \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "Add soft snow falling in front of the scene",
    "image_data_url": "data:image/png;base64,iVBORw0KGgo...",
    "size": "1024x1024"
  }'

响应示例

{"created": ..., "data": [{"b64_json": "..."}]}
:所有图片 ≤ 50 MB。建议压缩到 1024 边长。
POST/embeddings

Embeddings

将文本转为向量,用于检索 / 相似度匹配。OpenAI 兼容格式。

参数

字段类型必填说明
modelstring必填向量模型 key。
inputstring|array必填单条文本或字符串数组。

请求示例

curl https://www.glouth.com/link/v1/embeddings \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"your-embedding-model","input":"Glouth Link"}'

响应示例

{
  "object": "list",
  "data": [{"object":"embedding","embedding":[0.012, -0.041, ...],"index":0}],
  "model": "your-embedding-model",
  "usage": {"prompt_tokens":3, "total_tokens":3}
}
POST/rerank

Rerank

对文档列表按 query 相关度重排,常用于搜索结果优化。

参数

字段类型必填说明
modelstring必填Rerank 模型 key。
querystring必填查询语句。
documentsarray必填候选文档字符串数组。
top_ninteger可选返回前 N 条。

请求示例

curl https://www.glouth.com/link/v1/rerank \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"your-rerank-model","query":"glouth","documents":["a","b","c"],"top_n":2}'

响应示例

{"results":[{"index":2,"relevance_score":0.81},...]}
GET/models

模型列表

返回当前 Key 可见的模型集合。若 Key 设置了 allowed_models 白名单,响应自动收窄。

请求示例

curl https://www.glouth.com/link/v1/models \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY"

响应示例

{
  "object": "list",
  "data": [
    {"id":"gpt-5.4","object":"model","created":1778000000,"owned_by":"glouth"},
    {"id":"gpt-5.4-mini","object":"model","created":1778000000,"owned_by":"glouth"},
    ...
  ]
}
POST/codex/chat/completions

Codex 专线

Codex 专线是同等能力的低价模型组(codex-* 前缀,价格约低 30%),适合代码生成、批量任务、长流水线场景。响应结构跟 /chat/completions 完全一致。

参数

字段类型必填说明
modelstring必填必须是 codex-* 前缀的模型。
messagesarray必填同 /chat/completions。
其他参数mixed可选reasoning_effort / stream / tools 等完全等同于 /chat/completions。

请求示例

curl https://www.glouth.com/link/v1/codex/chat/completions \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"codex-gpt-5.5","messages":[{"role":"user","content":"hi"}]}'

响应示例

{… 结构同 /chat/completions …}
GET/dashboard/billing/usage

账单与用量

查询当前 Key 关联的余额、硬额度、今日 / 本月消耗、近 30 天模型占比。响应字段稳定。别名 GET /key/usage。

请求示例

curl https://www.glouth.com/link/v1/dashboard/billing/usage \
  -H "Authorization: Bearer $GLOUTH_LINK_KEY"

响应示例

{
  "balance_cents": 12345,
  "hard_limit_cents": 100000,
  "used_cents": {"today": 482, "this_month": 4152, "this_30d": 5811},
  "request_count": 1234,
  "by_model_30d": [{"model":"gpt-5.4-mini","requests":612,"cost_cents":2103}, ...]
}

推理程度调节(reasoning_effort)

更深推理 → 答案更稳但更慢更贵。Glouth 支持 4 档:low / medium / high / xhigh(后者为 Glouth 扩展)。

Chat Completions 协议

{
  "model": "gpt-5.4",
  "reasoning_effort": "high",
  "messages": [...]
}

Messages 协议

通过 thinking.budget_tokens 按预算自动映射:

{
  "model": "gpt-5.5",
  "thinking": {"type": "enabled", "budget_tokens": 4000},
  "messages": [...]
}

# 自动映射:
# <2000  → low
# <8000  → medium
# <16000 → high
# ≥16000 → xhigh

快速模式

2 个降延迟的方法:

方案一:设 reasoning_effort: "low"

不改模型,只降推理深度。

方案二:透传 service_tier

{"model": "gpt-5.4", "service_tier": "flex", "messages": [...]}

图片输入(Vision)

Chat Completions 风格

{
  "model": "gpt-5.4",
  "messages": [{
    "role": "user",
    "content": [
      {"type": "text", "text": "这是什么?"},
      {"type": "image_url", "image_url": {"url": "https://.../cat.jpg"}}
    ]
  }]
}

Messages 风格

{
  "model": "gpt-5.5",
  "max_tokens": 512,
  "messages": [{
    "role": "user",
    "content": [
      {"type": "text", "text": "这是什么?"},
      {"type": "image", "source": {"type": "base64", "media_type": "image/jpeg", "data": "..."}}
    ]
  }]
}

流式 SSE

所有对话端点支持 stream:true。请求 Accept: text/event-stream,响应按 SSE 分帧。

Chat Completions 风格响应帧

data: {"id":"...","object":"chat.completion.chunk","choices":[{"delta":{"content":"H"}}]}

data: {"id":"...","object":"chat.completion.chunk","choices":[{"delta":{"content":"i"}}]}

data: {"id":"...","object":"chat.completion.chunk","choices":[{"finish_reason":"stop","delta":{}}],"usage":{...}}

data: [DONE]

Messages 风格响应帧

event: message_start
data: {"type":"message_start","message":{...}}

event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}

event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"H"}}

...

event: message_stop
data: {"type":"message_stop"}

提示缓存(Prompt Caching)

常用系统 prompt 自动被上游缓存,后续命中价格降至 input 的 10%。Glouth 不需要你做任何特殊设置 — 上游(OpenAI / Anthropic)自动判定。

响应 usage.prompt_tokens_details.cached_tokens 字段告诉你这次命中了多少 cache。

函数调用 / Tools

OpenAI 风格

{
  "model": "gpt-5.4",
  "messages": [...],
  "tools": [{
    "type": "function",
    "function": {
      "name": "get_weather",
      "description": "获取某地天气",
      "parameters": {
        "type": "object",
        "properties": {"city": {"type":"string"}}
      }
    }
  }],
  "tool_choice": "auto"
}

Anthropic 风格

{
  "model": "claude-3-5-sonnet-20241022",
  "max_tokens": 512,
  "messages": [...],
  "tools": [{
    "name": "get_weather",
    "description": "获取某地天气",
    "input_schema": {"type":"object","properties":{"city":{"type":"string"}}}
  }]
}

Claude Code 集成

用 Glouth Link 取代官方 Anthropic 端点,RMB 充值 + 国内直连。

建议配置

# 一键安装(macOS / Linux)
curl -fsSL https://www.glouth.com/link/claude/setup.sh | sh

# 或手动配置 ~/.claude/settings.json
{
  "apiKeyHelper": "echo \"$GLOUTH_LINK_KEY\"",
  "env": {
    "ANTHROPIC_API_KEY": "$GLOUTH_LINK_KEY",
    "ANTHROPIC_BASE_URL": "https://www.glouth.com/link/v1"
  }
}

OpenAI SDK

Node.js / TypeScript

import OpenAI from 'openai'
const client = new OpenAI({
  apiKey: process.env.GLOUTH_LINK_KEY,
  baseURL: 'https://www.glouth.com/link/v1',
})

Python

from openai import OpenAI
client = OpenAI(
    api_key=os.environ['GLOUTH_LINK_KEY'],
    base_url='https://www.glouth.com/link/v1',
)

Anthropic SDK

from anthropic import Anthropic
client = Anthropic(
    api_key=os.environ['GLOUTH_LINK_KEY'],
    base_url='https://www.glouth.com/link/v1',
)

错误码

HTTP类型说明
400invalid_request_error请求体不合法:JSON 错误、参数类型错、图片格式不支持等。
401authentication_errorAPI Key 缺失、已吊销或格式错误。检查 Authorization: Bearer 或 x-api-key 头。
403permission_errorKey 没有该端点或该模型的使用权限。在 Console 调整白名单。
404invalid_request_error端点或模型不存在 / 被禁用。响应 code 字段说明是 endpoint_not_found 还是 model_not_found。
422invalid_request_error语义错误:超过消息条数或字符上限,或对非流式端点传了 stream:true。
429rate_limit_error触发 Key 级 RPM 限速,或这把 Key 已用完月度额度。
502server_error调用上层服务异常。X-Glouth-Request-ID 头可用于提工单。
503server_error暂时无可用线路。通常几秒后重试成功。

提工单请把响应头里的 X-Glouth-Request-ID 一并发给客服。