跳到正文
指南
指南

快速开始

通过受支持的同步或流式协议调用 RunAPI 语言模型。

RunAPI 通过常见的公开协议结构提供语言模型。将兼容客户端指向 https://runapi.ai,使用 RunAPI model identifier,并通过标准 API Key 完成身份验证。

选择协议

  • OpenAI-compatible Chat Completions 使用 POST /v1/chat/completions
  • OpenAI-compatible Responses 使用 POST /v1/responses
  • Anthropic-compatible Messages 使用 POST /v1/messages
  • Gemini-compatible content generation 使用 /v1beta/models/{model}:generateContent:streamGenerateContent

选择与现有客户端和应用流程最匹配的协议。模型目录会标明每个模型支持的公开协议。

发送请求

下面的 Chat Completions 请求会返回一次同步响应:

SHELL
curl "https://runapi.ai/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "概括幂等性为什么重要。"}]
  }'

请求与响应应始终保持所选协议的结构。工具调用、结构化输出、准确字段与模型专属限制以对应 operation 的 API Reference 为准。

流式接收输出

启用所选协议的 streaming option,并逐步消费返回的 server-sent events。Chat Completions 请求加入 "stream": true;Gemini-compatible 调用使用 :streamGenerateContent operation。客户端收到该协议的终止事件后关闭 stream。

检查 delivery fidelity

每个已接受的 LLM 响应都包含 X-RunAPI-Fidelityfull 表示请求在交付时没有省略字段;lossy 表示 RunAPI 为完成请求省略了可选控制,X-RunAPI-Omitted-Fields 会以逗号分隔列出这些字段。无法保留必要 lifecycle、continuation、tool 或 typed-item 语义的请求,会在创建 Task 前被拒绝。

这两个 header 均通过 CORS 暴露,browser client 可以直接读取。应用需要核对准确 delivery behavior 时,应将它们与 request identifier 一同记录。

处理错误与 usage

401 视为身份验证失败,将 4xx 响应视为请求或策略问题,只重试瞬时服务端或网络故障。从最终响应或终止 stream event 中读取所选协议结构里的 token usage,并在应用日志中保留 request identifier 以便排查。