API 文档

基础 URL 和认证

API 位于 https://api.ollamaapidoc.com/v1. 您通过在请求头中包含 Bearer 令牌进行身份验证。 Authorization 。在仪表板上通过 Google 或电子邮件即时生成您的密钥。无需电话号码。该密钥可与标准 OpenAI SDK 配合使用，只需设置基础 URL。

您的第一次请求

向以下地址发送 POST 请求 /v1/chat/completions 使用模型 ID uncensored. 此端点处理文本输入和文本输出。它支持流式传输、JSON 模式和函数调用。您可以通过先检查 models 端点来测试连通性而不花费额度。

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

响应返回标准的 OpenAI 格式。错误返回适当的 HTTP 代码。检查正文以获取 error 如果发生错误，请查看详细信息。流式响应使用服务器发送事件 (SSE)。

Python SDK 集成

安装官方 OpenAI 库。使用您的基础 URL 和 API 密钥配置客户端。调用 chat completions 端点。代码与标准 OpenAI 用法完全相同。这确保了现有项目的轻松迁移。您可以直接在调用中调整 temperature 和 top_p 等参数。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaapidoc.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

处理速率限制或无效密钥的异常。如果您将 stream 设置为 true，该库会流式传输 token。这种方法使您的代码库保持整洁且兼容。

Node.js SDK 设置

使用 openai npm 包。使用自定义 base URL 初始化客户端。传入您的 API 密钥。语法与 Python 示例类似。这种一致性减少了调试时间。您可以在对话历史数组中发送多条消息。

Copyimport OpenAI from "openai";

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

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

仔细解析响应。API 返回结构化的 JSON。错误处理对于生产环境应用至关重要。分别捕获网络错误和 API 特定错误。这确保您的应用在高流量期间保持响应能力。

流式传输与 JSON 模式

通过将 stream 参数设为 true。API 通过服务器发送事件发送令牌。您实时接收部分响应。这改善了长输出的用户体验。您还可以使用 response_format. 这对于结构化数据提取很有用。

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

函数调用工作方式类似。在请求中定义工具。模型返回工具调用。在代码中解析这些调用。执行它们并将结果反馈给模型。此循环支持复杂的工作流。

限制、错误和上下文

上下文窗口为 100,000 个 token。最大输出为每次请求 16,000 个 token。错误包括 401（无效密钥）和 402（余额不足）。速率限制上限为每分钟 300 次请求。请在您的应用中优雅地处理这些情况。API 不会将您的提示词用于训练。隐私得到保障。额度不会过期。