OpenAI 兼容格式

CokeAPI /v1 协议与 OpenAI 完全兼容,把 base_url 切到本平台即可零改动接入。

CokeAPI 的 /v1/* 接口协议层完全对齐 OpenAI,所有按 OpenAI SDK / OpenAI Endpoint 编写的客户端,只需把 base_url (或 OPENAI_BASE_URL 环境变量) 替换成 https://api.cokeapi.com/v1,代码零改动。

兼容矩阵

接口	OpenAI 路径	CokeAPI 状态	文档
Chat Completions	`POST /v1/chat/completions`	✅ 已支持	Chat Completions
Streaming (SSE)	同上 + `stream=true`	✅ 已支持	同上
Function Calling	同上 + `tools`	✅ 透传	同上
Models List	`GET /v1/models`	✅ 已支持	List Models
Images Generations	`POST /v1/images/generations`	✅ 已支持	GPT-Image-2
Images Edits	`POST /v1/images/edits`	✅ 已支持	同上
Images Variations	`POST /v1/images/variations`	🔜 计划中	—
Embeddings	`POST /v1/embeddings`	🔜 计划中	—
Audio (TTS / STT)	`POST /v1/audio/*`	🔜 计划中	—
Files	`POST /v1/files`	🔜 计划中	—
Assistants v2	`POST /v1/threads/*`	❌ 不在路线图	—

切换 base_url 示例

from openai import OpenAI

# 唯一改动:加 base_url
client = OpenAI(
    base_url="https://api.cokeapi.com/v1",
    api_key="sk-coke-xxxxxxxx",
)

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.cokeapi.com/v1",
  apiKey: process.env.COKEAPI_KEY,
});

# 把 https://api.openai.com 替换为 https://api.cokeapi.com 即可
curl https://api.cokeapi.com/v1/chat/completions \
  -H "Authorization: Bearer sk-coke-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "model": "gpt-4o-mini", "messages": [{"role":"user","content":"hi"}] }'

export OPENAI_BASE_URL=https://api.cokeapi.com/v1
export OPENAI_API_KEY=sk-coke-xxxxxxxx
# OpenAI SDK 自动读取,业务代码无需改

错误响应也兼容

CokeAPI 错误响应统一使用 OpenAI 风格,额外附加 code (业务码) 和 trace_id (排障 ID):

{
  "error": {
    "type": "rate_limit_exceeded",
    "code": 429101,
    "message": "操作过于频繁",
    "trace_id": "01HX..."
  }
}

完整错误码见错误码。

兼容矩阵

切换 base_url 示例

错误响应也兼容

On this page