API

REST API 参考文档。涵盖 147 项服务，包含身份验证方式、端点说明及常见陷阱。

初始化设置

首次使用时，请阅读 setup.md 了解使用指南。

适用场景

当用户询问如何集成第三方 API 时，本技能提供以下支持：

• 身份验证文档
• 含 curl 示例的端点参考
• 速率限制与分页模式说明
• 需避免的常见错误

架构设计

apis/                    # 按类别组织的 API 参考文件
  ├── ai-ml.md           # OpenAI、Anthropic、Cohere 等
  ├── payments.md        # Stripe、PayPal、Square 等
  ├── communication.md   # Twilio、SendGrid、Slack 等
  └── ...

~/api/                   # 用户偏好设置（可选）
  └── preferences.md     # 示例代码的首选语言

快速参考

API 分类

如何浏览 API 文件

每个分类文件均包含多个 API 文档。请先查阅文件顶部的索引：

1. 优先阅读索引 — 每个文件开头均附有索引表格，列出各 API 名称及其起始行号
2. 跳转至特定 API — 根据行号直接定位对应章节（每节约 50–100 行）
3. 示例：

   # 查看索引
   head -20 apis/ai-ml.md
   # 阅读特定 API 章节
   sed -n '119,230p' apis/ai-ml.md
   

核心规则

1. 首先定位正确文件 — 使用「API 分类」表格查找目标服务。

2. 先读索引，再跳转 — 每个文件均含索引，仅阅读所需部分即可。

3. 务必指定 Content-Type — 对 POST/PUT/PATCH 请求，必须设置 Content-Type: application/json。

4. 妥善处理速率限制 — 检查 X-RateLimit-Remaining 响应头，并在收到 429 状态码时实现退避重试。

5. 校验响应内容 — 部分 API 在发生错误时仍返回 HTTP 200，需检查响应体结构确认实际状态。

6. 使用幂等性密钥 — 针对支付及关键操作启用幂等性保障。

常见错误

• POST 请求遗漏 Content-Type: application/json
• 将 API 密钥置于 URL 查询参数中（应改用请求头）
• 忽略分页机制（多数 API 默认仅返回 10–25 条结果）
• 未为 429 或 5xx 错误实现重试逻辑
• 误认为 HTTP 200 即代表操作成功

作用范围

本技能仅提供文档支持，具体包括：

• API 端点参考
• 身份验证模式说明
• 供参考的代码示例

用户需自行管理 API 密钥，并亲自执行相关命令。

外部端点说明

本技能所记录均为外部 API。文中所示示例端点均属于对应服务提供商（如 Stripe、OpenAI 等）。

关联技能

若用户确认安装，可使用 clawhub install 命令安装以下技能：

• http — HTTP 请求模式
• webhook — Webhook 处理
• json — JSON 数据处理

反馈

• 若本技能有用：执行 clawhub star api
• 保持更新：执行 clawhub sync