对接文档

curl https://api.yunzhiapi.cn/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "模型展示名",
    "messages": [
      {"role": "user", "content": "请用一句话介绍云智API"}
    ],
    "stream": false
  }'

{
  "id": "chatcmpl_2f8f0c2a9b1d4e6f",
  "object": "chat.completion",
  "created": 1783820400,
  "model": "模型展示名",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "云智API 是统一接入多种大模型的接口网关。"
      },
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 18,
    "completion_tokens": 21,
    "total_tokens": 39,
    "prompt_tokens_details": {"cached_tokens": 0},
    "completion_tokens_details": {"reasoning_tokens": 0}
  }
}

curl -i https://api.yunzhiapi.cn/healthz

curl https://api.yunzhiapi.cn/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

curl https://api.yunzhiapi.cn/v1/models \
  -H "x-api-key: YOUR_API_KEY"

curl "https://api.yunzhiapi.cn/v1beta/models?key=YOUR_API_KEY"

{
  "object": "list",
  "data": [
    {"id": "模型展示名", "object": "model", "created": 1783820400, "owned_by": "mxgapi"}
  ]
}

{
  "data": [
    {
      "type": "model",
      "id": "模型展示名",
      "display_name": "模型展示名",
      "created_at": "2026-09-29T09:53:33Z"
    }
  ],
  "has_more": false,
  "first_id": "模型展示名",
  "last_id": "模型展示名"
}

{
  "error": {
    "message": "[GW-MODEL-002] model 模型展示名 was not found or is disabled",
    "type": "not_found_error",
    "param": null,
    "code": "GW-MODEL-002"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "[GW-REQ-005] prompt is required",
    "code": "GW-REQ-005"
  },
  "request_id": "req_2f8f0c2a9b1d4e6f"
}

{
  "error": {
    "code": 404,
    "message": "[GW-MODEL-002] model 模型展示名 was not found or is disabled",
    "status": "NOT_FOUND",
    "code_detail": "GW-MODEL-002"
  }
}

curl https://api.yunzhiapi.cn/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: order-20261022-001" \
  -d '{
    "model": "模型展示名",
    "messages": [
      {"role": "system", "content": "你是严谨的技术助手。"},
      {"role": "user", "content": [
        {"type": "text", "text": "描述这张图里的架构"},
        {"type": "image_url", "image_url": {"url": "https://example.com/arch.png"}}
      ]}
    ],
    "temperature": 0.3,
    "max_tokens": 1024,
    "stream": false
  }'

data: {"id":"chatcmpl_x","object":"chat.completion.chunk","created":1783820400,"model":"模型展示名","choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}

data: {"id":"chatcmpl_x","object":"chat.completion.chunk","created":1783820400,"model":"模型展示名","choices":[{"index":0,"delta":{"content":"云智"},"finish_reason":null}]}

data: {"id":"chatcmpl_x","object":"chat.completion.chunk","created":1783820400,"model":"模型展示名","choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":18,"completion_tokens":21,"total_tokens":39}}

data: [DONE]

curl https://api.yunzhiapi.cn/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "模型展示名",
    "input": "用三点总结这段需求",
    "instructions": "你是资深产品经理",
    "max_output_tokens": 1200,
    "store": false
  }'

{
  "id": "resp_2f8f0c2a9b1d4e6f",
  "object": "response",
  "created_at": 1783820400,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "model": "模型展示名",
  "output": [
    {
      "id": "msg_2f8f0c2a9b1d4e6f_0",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {"type": "output_text", "text": "第一点……", "annotations": [], "logprobs": []}
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {"effort": null, "summary": null},
  "store": false,
  "temperature": 1.0,
  "text": {"format": {"type": "text"}},
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 20,
    "input_tokens_details": {"cached_tokens": 0},
    "output_tokens": 80,
    "output_tokens_details": {"reasoning_tokens": 0},
    "total_tokens": 100
  },
  "metadata": {}
}

curl https://api.yunzhiapi.cn/v1/messages \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "模型展示名",
    "max_tokens": 1024,
    "system": "你是严谨的技术助手。",
    "messages": [
      {"role": "user", "content": "解释一下 SSE 流式输出"}
    ],
    "stream": false
  }'

{
  "id": "msg_2f8f0c2a9b1d4e6f",
  "type": "message",
  "role": "assistant",
  "model": "模型展示名",
  "content": [
    {"type": "text", "text": "SSE 是服务器向客户端单向推送事件的文本协议……"}
  ],
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 24,
    "output_tokens": 128,
    "cache_read_input_tokens": 0,
    "cache_creation_input_tokens": 0
  }
}

event: message_start
data: {"type":"message_start","message":{"id":"msg_x","type":"message","role":"assistant","content":[],"model":"模型展示名","stop_reason":null,"usage":{"input_tokens":24,"output_tokens":0}}}

event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}

event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"SSE"}}

event: content_block_stop
data: {"type":"content_block_stop","index":0}

event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"end_turn"},"usage":{"output_tokens":128}}

event: message_stop
data: {"type":"message_stop"}

curl https://api.yunzhiapi.cn/v1/messages/count_tokens \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "model": "模型展示名",
    "max_tokens": 1024,
    "messages": [{"role": "user", "content": "统计这段文本的输入 token"}]
  }'

{"input_tokens": 128}

MODEL="模型展示名"
curl "https://api.yunzhiapi.cn/v1beta/models/$(python -c "import urllib.parse,sys;print(urllib.parse.quote(sys.argv[1]))" "$MODEL"):generateContent" \
  -H "Content-Type: application/json" \
  -H "x-goog-api-key: YOUR_API_KEY" \
  -d '{
    "contents": [
      {"role": "user", "parts": [{"text": "用三点介绍云智API"}]}
    ],
    "generationConfig": {
      "temperature": 0.4,
      "maxOutputTokens": 1024
    }
  }'

{
  "candidates": [
    {
      "content": {
        "role": "model",
        "parts": [{"text": "一、统一接入；二、流式输出；三、透明计费。"}]
      },
      "finishReason": "STOP",
      "index": 0,
      "safetyRatings": []
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 16,
    "candidatesTokenCount": 32,
    "totalTokenCount": 48,
    "cachedContentTokenCount": 0,
    "thoughtsTokenCount": 0
  },
  "modelVersion": "模型展示名",
  "responseId": "gem_2f8f0c2a9b1d4e6f"
}

curl -N "https://api.yunzhiapi.cn/v1beta/models/%E6%A8%A1%E5%9E%8B%E5%B1%95%E7%A4%BA%E5%90%8D:streamGenerateContent" \
  -H "Content-Type: application/json" \
  -H "x-goog-api-key: YOUR_API_KEY" \
  -d '{
    "contents": [{"role":"user","parts":[{"text":"写一段产品介绍"}]}],
    "generationConfig": {"maxOutputTokens": 512}
  }'

curl "https://api.yunzhiapi.cn/v1beta/models/%E6%A8%A1%E5%9E%8B%E5%B1%95%E7%A4%BA%E5%90%8D:countTokens" \
  -H "Content-Type: application/json" \
  -H "x-goog-api-key: YOUR_API_KEY" \
  -d '{
    "contents": [{"role":"user","parts":[{"text":"估算这段输入的 token"}]}]
  }'

{"totalTokens": 96}

{
  "models": [
    {
      "name": "models/模型展示名",
      "displayName": "模型展示名",
      "description": "Gateway model 模型展示名",
      "supportedGenerationMethods": [
        "generateContent",
        "streamGenerateContent",
        "countTokens"
      ],
      "version": "001"
    }
  ]
}

curl https://api.yunzhiapi.cn/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "图像模型展示名",
    "prompt": "一只在花园里追蝴蝶的橘猫，水彩风格",
    "n": 1,
    "size": "1024x1024",
    "response_format": "b64_json"
  }'

curl https://api.yunzhiapi.cn/v1/images/edits \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "model=图像模型展示名" \
  -F "image=@/path/to/source.png" \
  -F "mask=@/path/to/mask.png" \
  -F "prompt=把背景换成夕阳下的海滩" \
  -F "n=1" \
  -F "size=1024x1024"

{
  "created": 1783820400,
  "data": [
    {"b64_json": "iVBORw0KGgo...", "revised_prompt": "..."}
  ],
  "usage": {"input_tokens": 12, "output_tokens": 4096, "total_tokens": 4108}
}

curl https://api.yunzhiapi.cn/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "语音模型展示名",
    "input": "欢迎使用云智API模型网关",
    "voice": "alloy",
    "response_format": "mp3"
  }' \
  -o speech.mp3

curl https://api.yunzhiapi.cn/v1/videos \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "视频模型展示名",
    "prompt": "海边日落，镜头缓慢推进，电影质感",
    "seconds": "8",
    "size": "1280x720",
    "n": 1
  }'

{
  "id": "video_2f8f0c2a9b1d4e6f",
  "object": "video",
  "created_at": 1783820400,
  "status": "queued",
  "model": "视频模型展示名",
  "progress": 0,
  "seconds": "8",
  "size": "1280x720"
}

curl https://api.yunzhiapi.cn/v1/videos/video_2f8f0c2a9b1d4e6f \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -L https://api.yunzhiapi.cn/v1/videos/video_2f8f0c2a9b1d4e6f/content \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o result.mp4

curl https://api.yunzhiapi.cn/v1/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/document.pdf" \
  -F "purpose=assistants"

{
  "id": "file_2f8f0c2a9b1d4e6f",
  "object": "file",
  "bytes": 184392,
  "created_at": 1783820400,
  "filename": "document.pdf",
  "purpose": "assistants",
  "status": "processed"
}

{
  "model": "模型展示名",
  "messages": [
    {
      "role": "user",
      "content": [
        {"type": "text", "text": "总结这份 PDF"},
        {"type": "file", "file": {"file_id": "file_2f8f0c2a9b1d4e6f"}}
      ]
    }
  ]
}

curl -N "https://api.yunzhiapi.cn/v1/streams/4f7c2a9d8e1b3c6a5d2e9f01" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -N "https://api.yunzhiapi.cn/v1/streams/4f7c2a9d8e1b3c6a5d2e9f01?after=128" \
  -H "Authorization: Bearer YOUR_API_KEY"

client_key = 请求头 Idempotency-Key（最长 200 字符，可为空）
material   = client_key 非空 ? "client:" + client_key : "auto:" + 网关请求 ID
idem_key   = sha256(api_key + "|" + material)

curl https://api.yunzhiapi.cn/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: order-20261022-001" \
  -d '{"model":"模型展示名","messages":[{"role":"user","content":"你好"}]}'

输入费用 = 1200 / 1,000,000 × 2 = 0.0024 元
输出费用 = 300  / 1,000,000 × 8 = 0.0024 元
合计费用 = 0.0048 元

# 第一轮
curl https://api.yunzhiapi.cn/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"模型展示名","input":"记住：项目代号是 Aurora。"}'

# 第二轮，把上一轮返回的 resp_ 开头 ID 填入
curl https://api.yunzhiapi.cn/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"模型展示名","input":"项目代号是什么？","previous_response_id":"resp_2f8f0c2a9b1d4e6f"}'

{
  "status": "ok",
  "database": "ok",
  "version": "final-2026.10",
  "uptime_seconds": 86400,
  "time": "2026-10-22T08:00:00Z"
}

pip install openai
npm install openai

from openai import OpenAI

client = OpenAI(
    base_url="https://api.yunzhiapi.cn/v1",
    api_key="YOUR_API_KEY",
    timeout=600.0,
    max_retries=0,
)

resp = client.chat.completions.create(
    model="模型展示名",
    messages=[{"role": "user", "content": "你好"}],
)
print(resp.choices[0].message.content)

stream = client.chat.completions.create(
    model="模型展示名",
    messages=[{"role": "user", "content": "写一首短诗"}],
    stream=True,
)
for chunk in stream:
    text = chunk.choices[0].delta.content if chunk.choices else None
    if text:
        print(text, end="", flush=True)

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.yunzhiapi.cn/v1",
  apiKey: "YOUR_API_KEY",
  timeout: 600000,
  maxRetries: 0
});

const resp = await client.chat.completions.create({
  model: "模型展示名",
  messages: [{ role: "user", content: "你好" }]
});
console.log(resp.choices[0].message.content);

import anthropic

client = anthropic.Anthropic(
    base_url="https://api.yunzhiapi.cn",
    api_key="YOUR_API_KEY",
    timeout=600.0,
    max_retries=0,
)

msg = client.messages.create(
    model="模型展示名",
    max_tokens=1024,
    messages=[{"role": "user", "content": "你好"}],
)
print(msg.content[0].text)

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  baseURL: "https://api.yunzhiapi.cn",
  apiKey: "YOUR_API_KEY",
  timeout: 600000,
  maxRetries: 0
});

const msg = await client.messages.create({
  model: "模型展示名",
  max_tokens: 1024,
  messages: [{ role: "user", content: "你好" }]
});
console.log(msg.content[0].text);

import { GoogleGenAI } from "@google/genai";

const ai = new GoogleGenAI({
  apiKey: "YOUR_API_KEY",
  httpOptions: { baseUrl: "https://api.yunzhiapi.cn" }
});

const resp = await ai.models.generateContent({
  model: "模型展示名",
  contents: "你好"
});
console.log(resp.text);

from google import genai

client = genai.Client(
    api_key="YOUR_API_KEY",
    http_options={"base_url": "https://api.yunzhiapi.cn"}
)

resp = client.models.generate_content(
    model="模型展示名",
    contents="你好"
)
print(resp.text)

export ANTHROPIC_BASE_URL="https://api.yunzhiapi.cn"
export ANTHROPIC_AUTH_TOKEN="YOUR_API_KEY"
export ANTHROPIC_MODEL="模型展示名"
export ANTHROPIC_DEFAULT_OPUS_MODEL="模型展示名"
export ANTHROPIC_DEFAULT_SONNET_MODEL="模型展示名"
export ANTHROPIC_DEFAULT_HAIKU_MODEL="模型展示名"
export CLAUDE_CODE_SUBAGENT_MODEL="模型展示名"
export CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY="1"
claude

model_provider = "mxgapi"
model = "模型展示名"
model_reasoning_effort = "high"
model_reasoning_summary = "none"
model_context_window = 131072
model_auto_compact_token_limit = 120000

[model_providers.mxgapi]
name = "mxgapi"
base_url = "https://api.yunzhiapi.cn"
wire_api = "responses"
requires_openai_auth = true
experimental_bearer_token = "YOUR_API_KEY"

codex exec "总结当前仓库的目录结构"

[
  {
    "providerName": "mxgapi Chat",
    "config": {
      "access": { "type": "api-key", "apiKey": "YOUR_API_KEY" },
      "api": { "type": "openai-chat-completions", "baseUrl": "https://api.yunzhiapi.cn/v1" },
      "personalModelIds": ["模型展示名"]
    }
  },
  {
    "providerName": "mxgapi Responses",
    "config": {
      "access": { "type": "api-key", "apiKey": "YOUR_API_KEY" },
      "api": { "type": "openai-responses", "baseUrl": "https://api.yunzhiapi.cn" },
      "personalModelIds": ["模型展示名"]
    }
  },
  {
    "providerName": "mxgapi Anthropic",
    "config": {
      "access": { "type": "api-key", "apiKey": "YOUR_API_KEY" },
      "api": { "type": "anthropic-messages", "baseUrl": "https://api.yunzhiapi.cn" },
      "personalModelIds": ["模型展示名"]
    }
  }
]