首页
Templates
[服务名称] API

[服务名称] API

注意： 不需要在文档中写一级标题（# 标题），Hugo 会自动使用 front matter 中的 title 生成页面标题。

📋 服务概览

提示：

  • 访问地址（网页链接）：使用 Markdown 链接格式 [URL](URL)，会自动显示箭头图标（↗）
  • API 端点：如果包含占位符或需要动态替换，使用代码格式 `https://api.example.com/v1`；如果是固定 URL，可以使用链接格式

服务名称： [API 服务名称]
所属提供者： Provider 名称
API 端点： https://api.example.com/v1（如果有占位符）或 https://api.example.com/v1 （如果是固定 URL）
服务类型： [完全免费/有限免费/试用积分]
注册要求： [是否需要注册/信用卡/实名认证]

✅ 服务说明

[服务简称] API 是 [Provider 名称] 提供的 [服务形式描述，比如：开发者 API 接口、RESTful API 服务等]。

主要特点

  • [特点 1]： [详细说明]
  • [特点 2]： [详细说明]
  • [特点 3]： [详细说明]
  • [特点 4]： [详细说明]

🎁 可用模型

免费/试用模型列表

模型名称 上下文长度 输出长度 特点 适用场景
[model-1] [长度] [长度] [特点] [场景]
[model-2] [长度] [长度] [特点] [场景]
[model-3] [长度] [长度] [特点] [场景]

模型详细说明

[模型 1]

  • 上下文窗口： [具体数值]
  • 主要用途： [说明]
  • 优势： [说明]

[模型 2]

  • 上下文窗口： [具体数值]
  • 主要用途： [说明]
  • 优势： [说明]

🔢 配额和限制

免费层级限制

限制项 配额 说明
每日请求数 [数量] requests/day [说明]
每分钟请求数 [数量] requests/min [说明]
每日 Token 数 [数量] tokens/day [说明]
每分钟 Token 数 [数量] tokens/min [说明]
最大上下文长度 [数量] tokens [说明]
最大输出长度 [数量] tokens [说明]
并发请求 [数量] [说明]
试用积分 [金额] [有效期]
需要信用卡 ✅/❌ [说明]

⚠️ 重要限制

  1. [限制 1]： [详细说明]
  2. [限制 2]： [详细说明]
  3. [限制 3]： [详细说明]

配额重置时间

  • 每日配额： [重置时间，如 UTC 0:00]
  • 每分钟配额： [重置规则]
  • 试用积分： [有效期和过期规则]

💰 价格说明

免费/试用

  • 免费配额： [说明]
  • 试用积分： [金额和有效期]
  • 获取方式： [说明]

付费定价（如有）

模型 输入价格 输出价格 说明
[model-1] $[价格]/M tokens $[价格]/M tokens [说明]
[model-2] $[价格]/M tokens $[价格]/M tokens [说明]

🚀 如何使用

前提条件

1. 注册账户

如果 Provider 文档已说明注册流程，链接过去：

如果是 API 特有的注册流程，详细说明。

2. 获取 API 密钥

详细步骤（如果所有用户相同）：

步骤 1：登录开发者平台

  1. 访问 开发者平台
  2. 使用您的账户登录

步骤 2：创建 API 密钥

  1. [详细操作]
  2. [详细操作]
  3. 重要： 复制并安全保存您的 API 密钥

步骤 3：[可选步骤，如充值或绑定信用卡]

  1. [详细操作]
  2. [详细操作]

💻 代码示例

Python 示例

安装依赖：

Bash
pip install openai  # 或其他 SDK

基本使用：

Python
from openai import OpenAI

# 初始化客户端（请替换为您的 API 密钥）
client = OpenAI(
    base_url="https://api.example.com/v1",
    api_key="YOUR_API_KEY"
)

# 发送请求
response = client.chat.completions.create(
    model="model-name",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "你好，请介绍一下自己。"}
    ],
    max_tokens=1000,
    temperature=0.7
)

# 打印响应
print(response.choices[0].message.content)

# 查看 Token 使用情况
print(f"\n使用 Tokens: {response.usage.total_tokens}")

流式输出示例：

Python
# 流式输出（适合实时显示）
stream = client.chat.completions.create(
    model="model-name",
    messages=[
        {"role": "user", "content": "写一首关于 AI 的诗"}
    ],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

cURL 示例

基本请求：

Bash
curl https://api.example.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "model-name",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "你好，请介绍一下自己。"
      }
    ],
    "max_tokens": 1000,
    "temperature": 0.7
  }'

流式输出：

Bash
curl https://api.example.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "model-name",
    "messages": [{"role": "user", "content": "你好"}],
    "stream": true
  }'

Node.js 示例（可选）

JavaScript
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.example.com/v1',
  apiKey: 'YOUR_API_KEY',
});

async function main() {
  const completion = await client.chat.completions.create({
    model: 'model-name',
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: '你好，请介绍一下自己。' }
    ],
    max_tokens: 1000,
    temperature: 0.7,
  });

  console.log(completion.choices[0].message.content);
  console.log(`\n使用 Tokens: ${completion.usage.total_tokens}`);
}

main();

🌟 核心优势

技术优势

  1. [优势 1]：

    • [详细说明]
    • [数据支持]

  2. [优势 2]：

    • [详细说明]
    • [数据支持]

  3. [优势 3]：

    • [详细说明]
    • [数据支持]

与其他 API 对比

特性 [本服务] [竞品 1] [竞品 2]
免费配额 [数据] [数据] [数据]
请求速度 [数据] [数据] [数据]
模型数量 [数量] [数量] [数量]
上下文长度 [长度] [长度] [长度]
价格 [价格] [价格] [价格]
需要信用卡 ✅/❌ ✅/❌ ✅/❌

💡 实用建议

✅ 推荐做法

  1. [建议 1]：

    • [详细说明]
    • [代码示例]

  2. [建议 2]：

    • [详细说明]
    • [代码示例]

  3. [建议 3]：

    • [详细说明]

🎯 最佳实践

充分利用免费配额：

  • [建议 1]
  • [建议 2]
  • [建议 3]

优化 Token 使用：

  • [建议 1]
  • [建议 2]
  • [建议 3]

错误处理：

Python
import time
from openai import OpenAI, RateLimitError, APIError

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

def call_api_with_retry(messages, max_retries=3):
    """带重试机制的 API 调用"""
    for attempt in range(max_retries):
        try:
            response = client.chat.completions.create(
                model="model-name",
                messages=messages
            )
            return response
        except RateLimitError:
            print(f"达到速率限制，等待后重试... ({attempt + 1}/{max_retries})")
            time.sleep(2 ** attempt)  # 指数退避
        except APIError as e:
            print(f"API 错误: {e}")
            if attempt == max_retries - 1:
                raise
    
    return None

⚠️ 注意事项

  1. [注意事项 1]： [说明]
  2. [注意事项 2]： [说明]
  3. [注意事项 3]： [说明]

🎯 实际应用案例

案例 1：[应用场景名称]

场景描述： [描述]

Python
# 完整的代码示例
def example_case_1():
    """[功能描述]"""
    client = OpenAI(
        base_url="https://api.example.com/v1",
        api_key="YOUR_API_KEY"
    )
    
    # 实现代码
    response = client.chat.completions.create(
        model="model-name",
        messages=[
            {"role": "user", "content": "示例问题"}
        ]
    )
    
    return response.choices[0].message.content

# 使用示例
result = example_case_1()
print(result)

案例 2：[应用场景名称]

场景描述： [描述]

Python
# 代码示例

🔧 常见问题

Q: [问题 1]
A: [回答]

Q: [问题 2]
A: [回答]

Q: [问题 3]
A: [回答]

Q: [问题 4]
A: [回答]

Q: [问题 5]
A: [回答]

🔗 相关资源

📝 更新日志

  • [年月]： [API 更新、新模型、配额变化]
  • [年月]： [API 更新、新模型、配额变化]
  • [年月]： [API 更新、新模型、配额变化]

服务提供者： [提供者名称]

最后更新于
[提供者中文名称]文档写作指南