首页资源中心
04DOCUMENTATION & SUPPORT

文档与支持

从第一行代码,到你的下一个产品。

接入指南 / API5 种语言 · 普通与流式调用直接查看代码

快速开始

准备好密钥、模型和可用额度,即可发送第一次请求。

模型调用使用 Relay API Key;登录面板的 Access Token 和 PAT 不能替代它。

环境配置

将密钥保存在服务端环境变量中,并把 SDK 的 Base URL 指向下方地址。

BASE URLhttps://keda8.ai/v1
AUTHORIZATIONBearer $AI_API_KEY
CONTENT-TYPEapplication/json
Terminal
export AI_API_KEY="YOUR_RELAY_API_KEY"
export AI_BASE_URL='https://keda8.ai/v1'

将 YOUR_RELAY_API_KEY 替换为你创建的密钥。上述配置对当前终端会话生效,请在同一终端运行后续代码。Base URL 不要重复追加 /v1。

多语言调用

选择你熟悉的语言,复制完整示例。普通请求等待完整结果,流式请求持续接收输出。

POST /chat/completions
request.sh
curl --fail-with-body "https://keda8.ai/v1/chat/completions" \
  --connect-timeout 10 --max-time 60 \
  -H "Authorization: Bearer $AI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "YOUR_CONFIGURED_MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "stream": false
}'
cURL 7.76+。Windows 用户请在 WSL 或 Git Bash 中运行此示例。
安装与运行
bash request.sh

此示例直接输出原始 JSON 或 SSE 事件。Python 和 JavaScript SDK 示例会提取回复文本。

把 YOUR_CONFIGURED_MODEL_ID 替换为「模型与价格」页面中的真实模型 ID。示例仅适用于明确支持 Chat Completions 的模型;其他能力请先核对模型说明。

理解响应

下方为结构示例,字段与 Token 数用于说明格式,不代表实际请求结果。

response.json
{
  "id": "chatcmpl-example",
  "object": "chat.completion",
  "model": "YOUR_CONFIGURED_MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello!"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 2,
    "total_tokens": 11
  }
}

choices[0].message.content读取完整回复文本。

finish_reason检查生成的结束原因,例如 stop 或 length;输出长度受限时可能需要继续生成。

usage查看输入、输出及总 Token 用量,实际计费以调用日志为准。

接口与参数

以下路径相对于 Base URL。是否可用取决于模型能力、密钥权限与后端配置。

POST/chat/completions
对话补全

本页示例使用的接口,适用于明确支持 Chat Completions 的模型。

GET/models
可用模型

使用 Relay API Key 查询可访问的模型列表;价格请查看「模型与价格」。

POST/embeddings
向量嵌入

仅用于支持 Embeddings 的模型,请传入对应模型 ID 与 input。

POST/images/generations
图像生成

仅用于支持图像生成的模型,参数和计费方式以模型说明为准。

Chat Completions 请求参数

参数类型 / 要求说明
modelstring必填「模型与价格」页面中的完整模型 ID,须与密钥可访问的模型一致。
messagesarray必填按顺序传入对话消息,每条消息包含 role 与 content。
streamboolean可选设为 true 接收 SSE 事件;普通请求返回完整 JSON。
temperaturenumber按模型支持控制采样随机性,范围与支持情况以具体模型为准。
max_completion_tokensinteger按模型支持限制生成 Token 数;部分模型使用 max_tokens,请遵循模型说明。

工具调用、结构化输出、图片输入及其他参数并非所有模型通用。建议从最小请求开始,再逐项增加已确认支持的参数。

错误排查

先查看 HTTP 状态码与错误正文,再检查对应配置。不同上游的错误映射可能不同,应结合实际 message 判断。

400
请求格式不正确

检查 JSON、必填字段、上下文长度,以及模型是否支持所传参数。

401
密钥认证失败

确认使用有效的 Relay API Key,并检查 Authorization: Bearer 后是否有多余空格。

402 / 403
余额或权限受限

结合错误正文检查账户余额、密钥额度、分组、模型权限与 IP 限制。

404
端点或模型不存在

检查 Base URL 是否只包含一次 /v1,并核对完整模型 ID 与端点。

429
请求频率或额度受限

查看错误正文区分限流与配额;限流时降低并发,并在适用时遵循 Retry-After。

5xx
网关或上游服务异常

保存错误正文与请求标识,查看调用日志;确认适合重试后再使用有限次数的退避。

TIMEOUT
连接超时或流式中断

检查网络和代理缓冲、客户端超时;已返回部分内容时,不要直接当作完整回答。

网络错误不一定表示请求未被处理。流式输出中断或请求超时后,请先查看调用日志,再决定是否重新提交。

常见问题

排查与支持

遇到调用问题?从密钥、模型配置和调用记录开始检查。

让问题更容易复现

记录发生时间、模型 ID、端点、SDK 版本和完整错误信息。分享前请移除密钥与敏感内容。