DEVELOPER API

调用 API

兼容 OpenAI 风格接口,替换 base_url 与 api_key 即可完成接入。

快速开始

将 OpenAI SDK 的 base_url 指向本平台,并用控制台创建的 Key 作为 api_key

from openai import OpenAI

client = OpenAI(
    base_url="https://relay.example.com/v1",
    api_key="sk-relay-prod-REPLACE_WITH_YOUR_KEY",
)

resp = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "ping"}],
)
print(resp.choices[0].message.content)

响应头包含 x-relay-request-id、计费来源类型与服务版本, 可用于核对账单与排障。

兼容端点

GET/v1/models返回当前可调用模型清单。
POST/v1/chat/completions对话补全,支持普通与 SSE 流式响应。
POST/v1/responsesResponses 接口,支持普通与 SSE 流式响应。
POST/v1/embeddings文本向量化接口。

平台透传常用请求参数,不在响应正文中插入营销信息或额外模型文本。

错误契约

所有错误返回统一结构,包含原因、是否可重试与请求编号:

{
  "error": {
    "request_id": "req_01J...",
    "type": "billing_error",
    "code": "insufficient_balance",
    "message": "账户余额不足,当前请求未发送至上游。",
    "retryable": false,
    "retry_after_ms": null,
    "docs_url": "https://relay.example.com/docs/errors/insufficient-balance"
  }
}
insufficient_balanceHTTP 402

余额不足,本次请求未发送至上游。

model_not_in_entitlementHTTP 403

不限量月卡不包含此模型,请更换套餐 Key 或使用按量 Key。

rate_limit_errorHTTP 429

触发速率 / 并发 / 公平使用限制。

upstream_timeoutHTTP 504

上游响应超时,可按 retry_after_ms 重试。

需要排障?

每个请求都附带 x-relay-request-id,可在账单流水与用量中核对。