> ## Documentation Index
> Fetch the complete documentation index at: https://docs.venice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Venice API

> Venice API 文档 —— 通过一个 API 密钥私密、不受限制地访问 OpenAI 兼容的聊天、图像、音频和视频模型。

<div className="venice-hero-copy">
  <p className="venice-hero-tagline">通往私密、无限制访问智能的 API。</p>
  <p className="venice-hero-subtitle">单个 API 密钥背后的 OpenAI 兼容 chat、image、audio 和 video。</p>

  <div className="venice-hero-ctas">
    <a className="venice-hero-cta venice-hero-cta-primary" href="https://venice.ai/settings/api">获取 API 密钥 →</a>
    <a className="venice-hero-cta" href="/overview/getting-started">开始使用</a>
  </div>
</div>

<CodeGroup>
  ```bash curl theme={"system"}
  curl https://api.venice.ai/api/v1/chat/completions \
    -H "Authorization: Bearer $VENICE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "zai-org-glm-5-1",
      "messages": [{"role": "user", "content": "Build without permission."}]
    }'
  ```

  ```ts TypeScript theme={"system"}
  import OpenAI from "openai";

  const client = new OpenAI({
    apiKey: process.env.VENICE_API_KEY,
    baseURL: "https://api.venice.ai/api/v1",
  });

  const res = await client.chat.completions.create({
    model: "zai-org-glm-5-1",
    messages: [{ role: "user", content: "Build without permission." }],
  });
  ```

  ```python Python theme={"system"}
  import os
  from openai import OpenAI

  client = OpenAI(
      api_key=os.environ["VENICE_API_KEY"],
      base_url="https://api.venice.ai/api/v1",
  )

  res = client.chat.completions.create(
      model="zai-org-glm-5-1",
      messages=[{"role": "user", "content": "Build without permission."}],
  )
  ```
</CodeGroup>

<div className="venice-section-header">
  <p className="venice-section-eyebrow">端点</p>
  <h2 className="venice-section-title">一个 API，涵盖所有模态</h2>
  <p className="venice-section-subtitle">单个 API 密钥背后的 Chat、image、audio、video 和 embeddings。</p>
</div>

<div className="venice-apis-grid">
  <a className="venice-api-card" href="/api-reference/endpoint/chat/completions">
    <span className="venice-api-card-name">Chat Completions</span>
    <p className="venice-api-card-desc">跨 100+ 文本模型的 OpenAI 兼容聊天，支持推理、工具调用和流式传输。</p>

    <div className="venice-api-card-chips">
      <span className="venice-api-card-chip">Streaming</span>
      <span className="venice-api-card-chip">Tools</span>
      <span className="venice-api-card-chip">Vision</span>
    </div>

    <span className="venice-api-card-action">查看参考 →</span>
  </a>

  <a className="venice-api-card" href="/api-reference/endpoint/image/generations">
    <span className="venice-api-card-name">图像生成</span>
    <p className="venice-api-card-desc">跨写实、风格化和无审查模型的文本到图像、图像到图像、放大和背景移除。</p>

    <div className="venice-api-card-chips">
      <span className="venice-api-card-chip">Text-to-image</span>
      <span className="venice-api-card-chip">Image-to-image</span>
      <span className="venice-api-card-chip">Upscale</span>
    </div>

    <span className="venice-api-card-action">查看参考 →</span>
  </a>

  <a className="venice-api-card" href="/api-reference/endpoint/audio/speech">
    <span className="venice-api-card-name">音频</span>
    <p className="venice-api-card-desc">采用 50+ 多语言语音的文本转语音，外加对任何音频文件的语音转文字转录。</p>

    <div className="venice-api-card-chips">
      <span className="venice-api-card-chip">TTS</span>
      <span className="venice-api-card-chip">Transcription</span>
      <span className="venice-api-card-chip">50+ voices</span>
    </div>

    <span className="venice-api-card-action">查看参考 →</span>
  </a>

  <a className="venice-api-card" href="/api-reference/endpoint/video/queue">
    <span className="venice-api-card-name">视频</span>
    <p className="venice-api-card-desc">通过同步或异步作业队列的文本到视频、图像到视频和参考到视频。</p>

    <div className="venice-api-card-chips">
      <span className="venice-api-card-chip">Text-to-video</span>
      <span className="venice-api-card-chip">Image-to-video</span>
      <span className="venice-api-card-chip">Reference-to-video</span>
    </div>

    <span className="venice-api-card-action">查看参考 →</span>
  </a>
</div>

<p className="venice-apis-extras">
  另外还有 <a href="/api-reference/endpoint/embeddings/generate">embeddings</a>、<a href="/guides/features/file-inputs">文件输入</a>、<a href="/guides/integrations/venice-mcp">MCP 工具</a> 和 <a href="/guides/integrations/x402-venice-api">钱包支付</a>。<a className="venice-apis-extras-cta" href="/api-reference">查看所有端点 →</a>
</p>

<div className="venice-section-header">
  <p className="venice-section-eyebrow">Agent</p>
  <h2 className="venice-section-title">为 AI agent 而构建</h2>
  <p className="venice-section-subtitle">为消息、编码和链上 agent 提供的私密推理、MCP 工具和钱包资助的工作流。</p>
</div>

<div className="venice-agents-cards">
  <a className="venice-api-card" href="/guides/integrations/ai-agents#agent-apps">
    <span className="venice-api-card-name">Agent 应用</span>
    <p className="venice-api-card-desc">通过 OpenClaw、Hermes 和 NanoClaw 将 Venice 连接到 WhatsApp、Telegram、Discord 等。</p>
    <span className="venice-api-card-action">查看集成 →</span>
  </a>

  <a className="venice-api-card" href="/guides/integrations/ai-agents#coding-agents">
    <span className="venice-api-card-name">编码 agent</span>
    <p className="venice-api-card-desc">将 Claude Code、Cursor 和 Codex CLI 与 Venice 模型一起用于私密编码工作流。</p>
    <span className="venice-api-card-action">查看集成 →</span>
  </a>

  <a className="venice-api-card" href="/guides/integrations/ai-agents#tools-and-skills">
    <span className="venice-api-card-name">MCP + Skills</span>
    <p className="venice-api-card-desc">将 chat、image、video、audio 和 embeddings 作为 MCP 工具或运行时 skill 暴露。</p>
    <span className="venice-api-card-action">查看集成 →</span>
  </a>
</div>

<p className="venice-apis-extras">
  <a className="venice-apis-extras-cta" href="/guides/integrations/ai-agents">探索 AI Agents 中心 →</a>
</p>

<div className="venice-section-header">
  <p className="venice-section-eyebrow">模型</p>
  <h2 className="venice-section-title">热门模型</h2>
  <p className="venice-section-subtitle">Venice 上一些使用最多的模型。将 ID 用作您的 `model` 参数。</p>
</div>

<div className="venice-models-grid">
  <a className="venice-model-card" href="/overview/models">
    <div className="venice-model-card-head">
      <span className="venice-model-card-name">Kimi K2.6</span>
      <span className="venice-model-card-maker">Moonshot AI</span>
    </div>

    <p className="venice-model-card-desc">开源权重的前沿推理。强大的长上下文和工具调用，价格仅为前沿水平的一小部分。</p>

    <div className="venice-model-card-stats">
      <span>256K context</span>
      <span>\$0.85 / \$4.66 per 1M</span>
      <span className="venice-model-card-privacy">Private</span>
    </div>

    <code className="venice-model-card-id">kimi-k2-6</code>
  </a>

  <a className="venice-model-card" href="/overview/models">
    <div className="venice-model-card-head">
      <span className="venice-model-card-name">Claude Opus 4.7</span>
      <span className="venice-model-card-maker">Anthropic</span>
    </div>

    <p className="venice-model-card-desc">编码、规划和需要保持连贯性的长时程 agent 的顶级选择。</p>

    <div className="venice-model-card-stats">
      <span>1M context</span>
      <span>\$6.00 / \$30.00 per 1M</span>
      <span className="venice-model-card-privacy">Anonymized</span>
    </div>

    <code className="venice-model-card-id">claude-opus-4-7</code>
  </a>

  <a className="venice-model-card" href="/overview/models">
    <div className="venice-model-card-head">
      <span className="venice-model-card-name">GPT-5.5</span>
      <span className="venice-model-card-maker">OpenAI</span>
    </div>

    <p className="venice-model-card-desc">具有 1M 上下文的前沿通用智能。chat、RAG 和多步推理的强大默认值。</p>

    <div className="venice-model-card-stats">
      <span>1M context</span>
      <span>\$6.25 / \$37.50 per 1M</span>
      <span className="venice-model-card-privacy">Anonymized</span>
    </div>

    <code className="venice-model-card-id">openai-gpt-55</code>
  </a>
</div>

<a className="venice-models-cta" href="/overview/models">
  <span className="venice-models-cta-left">
    <span className="venice-models-cta-count">250+ 个模型</span>
    <span className="venice-models-cta-sub">文本、图像、音频和视频</span>
  </span>

  <span className="venice-models-cta-action">浏览目录 →</span>
</a>

<div className="venice-section-header">
  <p className="venice-section-eyebrow">工具</p>
  <h2 className="venice-section-title">聊天模型的内置工具</h2>
  <p className="venice-section-subtitle">使用 `venice_parameters` 或 Venice 原生端点开启网页搜索、附加文件或查询区块链。</p>
</div>

<CardGroup cols={4}>
  <Card title="Web Search" icon="globe" />

  <Card title="Web Scraping" icon="browser" />

  <Card title="File Inputs" icon="file" />

  <Card title="Crypto RPC" icon="link" />
</CardGroup>

<Accordion title="Web 搜索代码示例">
  通过 `enable_web_search` 为任何文本模型添加带引用的实时网页搜索。

  <CodeGroup>
    ```bash Curl theme={"system"}
    curl https://api.venice.ai/api/v1/chat/completions \
      -H "Authorization: Bearer $VENICE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "model": "zai-org-glm-5-1",
        "messages": [{"role": "user", "content": "What are the latest developments in AI?"}],
        "venice_parameters": {
          "enable_web_search": "auto"
        }
      }'
    ```

    ```ts TypeScript theme={"system"}
    import OpenAI from "openai";

    const client = new OpenAI({
      apiKey: process.env.VENICE_API_KEY!,
      baseURL: "https://api.venice.ai/api/v1",
    });

    const completion = await client.chat.completions.create({
      model: "zai-org-glm-5-1",
      messages: [{ role: "user", content: "What are the latest developments in AI?" }],
      // @ts-expect-error - Venice-specific parameter
      venice_parameters: {
        enable_web_search: "auto",
      },
    });

    console.log(completion.choices[0].message.content);
    ```

    ```python Python theme={"system"}
    import os
    from openai import OpenAI

    client = OpenAI(
        api_key=os.environ["VENICE_API_KEY"],
        base_url="https://api.venice.ai/api/v1",
    )

    response = client.chat.completions.create(
        model="zai-org-glm-5-1",
        messages=[{"role": "user", "content": "What are the latest developments in AI?"}],
        extra_body={
            "venice_parameters": {
                "enable_web_search": "auto",
            }
        },
    )

    print(response.choices[0].message.content)
    ```

    ```bash Model Suffix theme={"system"}
    # Alternative: append parameters directly to the model ID
    curl https://api.venice.ai/api/v1/chat/completions \
      -H "Authorization: Bearer $VENICE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "model": "zai-org-glm-5-1:enable_web_search=on&enable_web_citations=true",
        "messages": [{"role": "user", "content": "What are the latest developments in AI?"}]
      }'
    ```
  </CodeGroup>
</Accordion>

<Accordion title="Web 抓取代码示例">
  设置 `enable_web_scraping: true`，模型在回答之前会获取并读取用户消息中的任何 URL。

  <CodeGroup>
    ```bash Curl theme={"system"}
    curl https://api.venice.ai/api/v1/chat/completions \
      -H "Authorization: Bearer $VENICE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "model": "openai-gpt-55",
        "messages": [
          {"role": "user", "content": "Summarize this post in five bullets: https://venice.ai/blog/how-to-use-venice-api"}
        ],
        "venice_parameters": {
          "enable_web_scraping": true
        }
      }'
    ```

    ```ts TypeScript theme={"system"}
    import OpenAI from "openai";

    const client = new OpenAI({
      apiKey: process.env.VENICE_API_KEY!,
      baseURL: "https://api.venice.ai/api/v1",
    });

    const response = await client.chat.completions.create({
      model: "openai-gpt-55",
      messages: [
        {
          role: "user",
          content:
            "Summarize this post in five bullets: https://venice.ai/blog/how-to-use-venice-api",
        },
      ],
      // @ts-expect-error - Venice-specific parameter
      venice_parameters: {
        enable_web_scraping: true,
      },
    });

    console.log(response.choices[0].message.content);
    ```

    ```python Python theme={"system"}
    import os
    from openai import OpenAI

    client = OpenAI(
        api_key=os.environ["VENICE_API_KEY"],
        base_url="https://api.venice.ai/api/v1",
    )

    response = client.chat.completions.create(
        model="openai-gpt-55",
        messages=[
            {
                "role": "user",
                "content": "Summarize this post in five bullets: https://venice.ai/blog/how-to-use-venice-api",
            }
        ],
        extra_body={
            "venice_parameters": {
                "enable_web_scraping": True,
            }
        },
    )

    print(response.choices[0].message.content)
    ```
  </CodeGroup>
</Accordion>

<Accordion title="文件输入代码示例">
  将 PDF、Office 文档、代码和文本文件（最大 25MB）直接附加到聊天请求。完整的格式列表请参阅 [文件输入指南](/guides/features/file-inputs)。

  <CodeGroup>
    ```bash Curl theme={"system"}
    # Encode a local file as a base64 data URL, then send it inline
    FILE_B64=$(base64 q3-report.pdf | tr -d '\n')

    curl https://api.venice.ai/api/v1/chat/completions \
      -H "Authorization: Bearer $VENICE_API_KEY" \
      -H "Content-Type: application/json" \
      -d "{
        \"model\": \"openai-gpt-55\",
        \"messages\": [
          {
            \"role\": \"user\",
            \"content\": [
              {\"type\": \"text\", \"text\": \"Summarize this report in five bullets and list the main risks.\"},
              {\"type\": \"file\", \"file\": {\"filename\": \"q3-report.pdf\", \"file_data\": \"data:application/pdf;base64,${FILE_B64}\"}}
            ]
          }
        ]
      }"
    ```

    ```ts TypeScript theme={"system"}
    import OpenAI from "openai";
    import { readFile } from "node:fs/promises";

    const client = new OpenAI({
      apiKey: process.env.VENICE_API_KEY!,
      baseURL: "https://api.venice.ai/api/v1",
    });

    const pdf = await readFile("q3-report.pdf");
    const fileData = `data:application/pdf;base64,${pdf.toString("base64")}`;

    const response = await client.chat.completions.create({
      model: "openai-gpt-55",
      messages: [
        {
          role: "user",
          content: [
            { type: "text", text: "Summarize this report in five bullets and list the main risks." },
            // @ts-expect-error - Venice file input block
            { type: "file", file: { filename: "q3-report.pdf", file_data: fileData } },
          ],
        },
      ],
    });

    console.log(response.choices[0].message.content);
    ```

    ```python Python theme={"system"}
    import base64
    import os
    from pathlib import Path
    from openai import OpenAI

    client = OpenAI(
        api_key=os.environ["VENICE_API_KEY"],
        base_url="https://api.venice.ai/api/v1",
    )

    path = Path("q3-report.pdf")
    file_data = "data:application/pdf;base64," + base64.b64encode(path.read_bytes()).decode("utf-8")

    response = client.chat.completions.create(
        model="openai-gpt-55",
        messages=[
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "Summarize this report in five bullets and list the main risks."},
                    {"type": "file", "file": {"filename": "q3-report.pdf", "file_data": file_data}},
                ],
            }
        ],
    )

    print(response.choices[0].message.content)
    ```
  </CodeGroup>
</Accordion>

<Accordion title="Crypto RPC 代码示例">
  使用您的 Venice 密钥或 x402 钱包跨 11 条支持的链代理 JSON-RPC 2.0 调用。链、方法和 credit 层级请参阅 [Crypto RPC 参考](/api-reference/endpoint/crypto/rpc)。

  <CodeGroup>
    ```bash Curl theme={"system"}
    curl https://api.venice.ai/api/v1/crypto/rpc/ethereum-mainnet \
      -H "Authorization: Bearer $VENICE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "jsonrpc": "2.0",
        "method": "eth_blockNumber",
        "params": [],
        "id": 1
      }'
    ```

    ```ts TypeScript theme={"system"}
    const response = await fetch(
      "https://api.venice.ai/api/v1/crypto/rpc/base-mainnet",
      {
        method: "POST",
        headers: {
          Authorization: `Bearer ${process.env.VENICE_API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify([
          { jsonrpc: "2.0", method: "eth_chainId", params: [], id: 1 },
          { jsonrpc: "2.0", method: "eth_blockNumber", params: [], id: 2 },
        ]),
      }
    );

    const results = await response.json();
    console.log(results);
    ```

    ```python Python theme={"system"}
    import os
    import requests

    response = requests.post(
        "https://api.venice.ai/api/v1/crypto/rpc/ethereum-mainnet",
        headers={
            "Authorization": f"Bearer {os.environ['VENICE_API_KEY']}",
            "Content-Type": "application/json",
        },
        json={
            "jsonrpc": "2.0",
            "method": "eth_getBalance",
            "params": ["0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "latest"],
            "id": 1,
        },
    )

    print(response.json())
    ```
  </CodeGroup>
</Accordion>

<div className="venice-pricing">
  <div className="venice-section-header">
    <p className="venice-section-eyebrow">定价</p>
    <h2 className="venice-section-title">充值、质押或按请求付费</h2>
    <p className="venice-section-subtitle">使用 credit 为账户充值，质押 DIEM 以获得每日津贴，或在 Base 上使用 USDC 完全跳过账户。</p>
  </div>

  <div className="venice-pricing-grid">
    <div className="venice-pricing-card">
      <div className="venice-pricing-card-head">
        <span className="venice-pricing-card-name">Credits</span>
        <span className="venice-pricing-card-badge">USD 或加密货币</span>
      </div>

      <p className="venice-pricing-card-desc">以美元或加密货币按用量付费。Credit 永不过期，适用于所有端点。</p>
      <a className="venice-pricing-card-cta" href="https://venice.ai/settings/billing">购买 Credit</a>
    </div>

    <div className="venice-pricing-card">
      <div className="venice-pricing-card-head">
        <span className="venice-pricing-card-name">DIEM</span>
        <span className="venice-pricing-card-badge">每日津贴</span>
      </div>

      <p className="venice-pricing-card-desc">一次性质押 DIEM 或 VVV，每天赚取固定的推理津贴，无每次调用费用。</p>
      <a className="venice-pricing-card-cta" href="https://venice.ai/token">了解 DIEM</a>
    </div>

    <div className="venice-pricing-card">
      <div className="venice-pricing-card-head">
        <span className="venice-pricing-card-name">x402</span>
        <span className="venice-pricing-card-badge">Base 上的 USDC</span>
      </div>

      <p className="venice-pricing-card-desc">从任何 Base 钱包使用 USDC 按请求付费。无需账户或 API 密钥，为 agent 而构建。</p>
      <a className="venice-pricing-card-cta" href="/guides/integrations/x402-venice-api">阅读 x402 指南</a>
    </div>
  </div>
</div>

有问题或反馈？加入我们的 [Discord](https://discord.gg/askvenice)。
