API 文档

兼容 OpenAI 和 Anthropic SDK，5 分钟完成接入。

menu_book

完整文档站

更全面的接入指南、模型说明与最佳实践，尽在独立文档站。

前往文档站arrow_forward

Base URL

https://your-domain.com

OpenAI 认证方式

Authorization: Bearer sk-xxx

Anthropic 认证方式

x-api-key: sk-xxx

快速入门

3 步开始使用 Zivv API。

注册并获取 API Key

在控制台注册账号，进入 API 令牌页面，创建一个 sk- 开头的 API Key。

配置 Base URL

将 OpenAI SDK 的 base_url 指向 https://zivv.pro/v1，或设置 ANTHROPIC_BASE_URL=https://zivv.pro 用于 Claude Code。

开始调用

使用你现有的代码，只需替换 Base URL 和 API Key。完整支持 OpenAI 和 Anthropic SDK 的所有功能。

API 端点

Zivv API 同时支持 OpenAI 和 Anthropic 两种协议格式。

方法	端点	说明
POST	/v1/chat/completions	Chat Completions（OpenAI 格式，支持流式输出）
POST	/v1/messages	Messages（Anthropic 格式，支持流式输出）
POST	/v1/responses	Responses（OpenAI Responses API，Codex CLI 使用）
POST	/v1/images/generations	图片生成（支持流式 SSE 输出）
POST	/v1/gemini/{model}:{method}	Gemini 原生协议透传（generateContent / streamGenerateContent）
GET	/v1/models	获取可用模型列表

代码示例

直接替换 Base URL 即可使用，无需修改其他代码。

curl https://your-domain.com/v1/chat/completions \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

客户端配置指南

主流 AI 工具和 SDK 的详细配置步骤。

设置环境变量后启动 Claude Code 即可，无需额外配置。

export ANTHROPIC_BASE_URL=https://your-domain.com
export ANTHROPIC_API_KEY=sk-your-key
claude

请求参数

按协议分类的支持参数。选择协议查看对应参数。

参数	类型	必填	说明
model	string	是	模型 ID，如 claude-sonnet-4-6
messages	array	是	消息对象数组，包含 role 和 content
stream	boolean	否	是否开启流式输出，默认 false
temperature	number	否	采样温度，0-2
top_p	number	否	核采样参数
max_tokens	number	否	最大输出 token 数
max_completion_tokens	number	否	max_tokens 的替代写法，效果相同
tools	array	否	函数工具定义，用于 tool use
tool_choice	string\|object	否	工具选择策略：auto / required / none / 指定工具

图片生成

使用 Images API 调用 gpt-image-2 生成图片，支持流式 SSE 输出。

💡 推荐开启 stream 模式：图片生成通常需要 30-120 秒，流式模式可避免 Cloudflare / 网关超时。

📝 如需图片编辑（基于已有图片修改），请使用 Responses API（/v1/responses）配合 gpt-5.5 等文本模型的 image_generation 工具。

代码示例

curl https://your-domain.com/v1/images/generations \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "A cute cat wearing sunglasses on a beach",
    "stream": true,
    "size": "1024x1024",
    "quality": "high"
  }'

SSE 流式响应格式

开启 stream 后，服务端通过 SSE 分块返回生成进度和最终图片（base64）。

SSE Events

event: progress
data: {"type":"progress","progress":25}

event: progress
data: {"type":"progress","progress":50}

event: progress
data: {"type":"progress","progress":75}

event: result
data: {"type":"result","index":0,"b64_json":"iVBORw0KGgo..."}

event: done
data: [DONE]

Responses API

OpenAI Responses API（/v1/responses）是 gpt-5.5 等新模型的原生接口，支持视觉理解和图片生成。

💡 gpt-5.5 带图请求推荐使用 Responses API。图片类型用 input_image，image_url 直接传字符串，无需包装为对象。

📝 通过 tools: [{type: "image_generation"}] 可让文本模型生成图片，支持图片编辑（基于已有图片修改）。

视觉理解 & 图片生成

Responses API 同时支持图片输入（视觉理解）和图片生成（通过 image_generation 工具）。

# Vision: send image to gpt-5.5
curl https://your-domain.com/v1/responses \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "input": [
      {
        "role": "user",
        "content": [
          { "type": "input_text", "text": "What is in this image?" },
          { "type": "input_image", "image_url": "https://example.com/photo.jpg" }
        ]
      }
    ]
  }'

# Image generation via Responses API
curl https://your-domain.com/v1/responses \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "input": "Generate an image of a sunset over mountains",
    "tools": [{ "type": "image_generation" }]
  }'

chat/completions vs responses 对比

	chat/completions	responses
请求字段	messages	input
图片类型	image_url	input_image
图片 URL 格式	{url: "..."}	"..."
图片生成	❌	image_generation tool
响应结构	choices[].message	output[]
多轮对话	❌	previous_response_id

准备好了吗？

创建账号，几秒钟即可获取 API Key。

免费注册 menu_book前往文档站