Thanks to visit codestin.com
Credit goes to readgzh.site

开发者文档
Developer Docs

API & MCP 接入指南

让你的 AI 应用能够读取微信公众号文章。提供 REST API 和 MCP 协议两种接入方式。

快速开始

最简单的方式:直接在浏览器访问以下 URL,即可获得 AI 可读的文章页面。

浏览器直接访问
https://api.readgzh.site/rd?url=https://mp.weixin.qq.com/s/你的文章ID

返回一个精简的 HTML 页面,AI 可以直接读取全文内容。

REST API

1. 抓取文章

提交微信文章链接,系统自动抓取内容并缓存,返回文章 ID 和短链接。

POST 请求
curl -X POST https://api.readgzh.site/rd \
  -H "Content-Type: application/json" \
  -d '{"url": "https://mp.weixin.qq.com/s/xxxxx"}'
响应示例
{
  "success": true,
  "articleId": "abc123-...",
  "slug": "s/article-title",
  "cached": false,
  "data": {
    "title": "文章标题",
    "author": "作者名",
    "content": "文章纯文本内容...",
    "publishTime": "2025-01-01",
    "sourceUrl": "https://mp.weixin.qq.com/s/..."
  }
}

2. 读取已缓存文章

通过 slug 或 ID 获取已缓存的文章内容(返回 HTML)。

GET 请求
# 通过 slug
GET https://api.readgzh.site/rd?s=article-title

# 通过 ID
GET https://api.readgzh.site/rd?id=abc123-...

2.1 长文分页读取(?part=N)

长文章会自动拆分为约 40KB 的分块。通过 part 参数逐段读取。 响应头 X-Total-PartsX-Current-Part 指示总块数和当前块。

分页读取
# 读取第 1 部分
GET https://api.readgzh.site/rd?s=article-title&part=1

# 读取第 2 部分
GET https://api.readgzh.site/rd?s=article-title&part=2

2.2 AI 智能摘要(?mode=summary)Pro

添加 mode=summary 参数,返回 AI 生成的 300-500 字结构化摘要(JSON 格式)。 摘要结果会自动缓存,后续请求直接返回。此功能为 Pro 专属。

摘要请求
GET https://api.readgzh.site/rd?s=article-title&mode=summary \
  -H "Authorization: Bearer sk_live_你的Pro_Key"
响应示例
{
  "success": true,
  "title": "文章标题",
  "author": "作者名",
  "summary": "📌 核心观点:...
📋 关键要点:...
🏷️ 标签:...",
  "content_url": "https://readgzh.site/article-slug",
  "total_parts": 3,
  "content_length": 12000
}

3. 一步到位(推荐)

GET 请求直接传入微信链接,自动抓取并返回可读 HTML。适合让 AI 直接访问。

GET 请求
GET https://api.readgzh.site/rd?url=https://mp.weixin.qq.com/s/xxxxx

返回精简的 HTML 页面,无需额外处理即可被 AI 直接读取。

ChatGPT Action 接入(自定义 GPTs)

你可以将 ReadGZH 集成为 ChatGPT 的自定义 Action,让你的 GPTs 能直接读取微信文章。

1. 创建或编辑 GPTs

  1. 打开 ChatGPT GPTs 编辑器
  2. 点击「Configure」→「Actions」→「Create new action」
  3. 在 Schema 输入框中选择「Import from URL」

2. 导入 OpenAPI 规范

粘贴以下 URL 导入 API 定义:

OpenAPI Spec URL
https://readgzh.site/.well-known/openapi.yaml

3. 配置鉴权

  1. Authentication Type 选择「API Key」
  2. Auth Type 选择「Bearer」
  3. 粘贴你的 API Key(sk_live_...,可在 控制台 创建)

4. 设置 GPTs 指令

在 GPTs 的 Instructions 中添加以下内容:

GPTs Instructions 示例
当用户分享微信公众号文章链接(mp.weixin.qq.com)时,
使用 readgzh.read action 读取文章全文内容,
然后根据用户需求进行总结、翻译或分析。

5. 测试

保存后,在 GPTs 对话中发送一个微信文章链接,GPTs 会自动调用 ReadGZH 读取全文。

MCP 协议接入

支持 Model Context Protocol (MCP), 可直接在 Claude Desktop、Cursor 等工具中使用。

一键安装

如果你使用 Cursor,点击下面的按钮可直接添加 ReadGZH MCP:

手动配置

Claude Desktop / Cline / Continue 等支持 MCP 的客户端,添加以下配置即可:

claude_desktop_config.json / cline_mcp_settings.json
{
  "mcpServers": {
    "readgzh": {
      "url": "https://api.readgzh.site/mcp-server"
    }
  }
}

配置文件位置:Claude Desktop(macOS)~/Library/Application Support/Claude/claude_desktop_config.json, Cursor ~/.cursor/mcp.json, Cline 在 VS Code 设置中搜索 cline.mcpServers

可用工具

readgzh.read

读取微信文章全文

参数: url: 微信文章链接

readgzh.search

按关键词搜索已缓存文章

参数: query: 搜索关键词

readgzh.list

列出最近缓存的文章

参数: limit: 返回数量(可选)

readgzh.list_by_account

列出某个公众号已缓存的文章(仅限 ReadGZH 缓存范围,非全量存档)

参数: account: 公众号名称;limit: 返回数量(可选)

readgzh.get

通过 slug 获取文章详情

参数: slug: 文章短链接

使用示例

配置完成后,你可以在 Claude 中这样使用:

💬 你:

请帮我读一下这篇微信文章 https://mp.weixin.qq.com/s/xxxxx

🤖 Claude:

好的,让我来读取这篇文章...(自动调用 ReadGZH 读取全文)

OpenClaw Skills 接入

ReadGZH 提供原生 OpenClaw Skill 支持, 可直接在 OpenClaw 中使用微信文章读取能力。

方式一:通过 MCP 接入(推荐)

OpenClaw 原生支持 MCP 协议。只需在 OpenClaw 的 MCP 配置中添加 ReadGZH 服务即可:

OpenClaw MCP 配置
{
  "mcpServers": {
    "readgzh": {
      "url": "https://api.readgzh.site/mcp-server"
    }
  }
}

配置完成后,OpenClaw 会自动发现 ReadGZH 提供的文章读取、搜索、列表等工具。

方式二:一键安装 Skill

如果 ReadGZH 已发布到 ClawHub,可直接一键安装:

通过 ClawHub 安装(推荐)
clawhub install readgzh

或者手动下载安装:

手动安装
mkdir -p ~/.openclaw/workspace/skills/readgzh
curl -o ~/.openclaw/workspace/skills/readgzh/SKILL.md \
  https://readgzh.site/.well-known/SKILL.md

安装后重启 OpenClaw,当用户提到「微信」「公众号」或分享 mp.weixin.qq.com 链接时,Skill 会自动触发。

配置 API Key(可选)

如需使用带鉴权的 API(更高配额),在 Skill 配置中添加 API Key:

config.yaml
api_key: "sk_live_你的Key"

使用示例

💬 你:

帮我读一下这篇微信文章 https://mp.weixin.qq.com/s/xxxxx

🤖 OpenClaw:

正在使用 ReadGZH 读取文章...(自动调用 readgzh skill)

国内 AI 平台接入

ReadGZH 提供标准 REST API 和 OpenAPI 规范,可无缝接入主流国内 AI 平台。

Coze(扣子)

  1. 在 Coze 中创建或编辑 Bot,进入「插件」→「创建插件」
  2. 选择「通过 URL 导入」,粘贴 OpenAPI 规范地址:
OpenAPI Spec URL
https://readgzh.site/.well-known/openapi.yaml
  1. 鉴权方式选择「Bearer Token」,填入你的 API Key
  2. 保存后即可在 Bot 对话中发送微信链接,自动调用 ReadGZH

Dify

  1. 进入 Dify 应用编辑器,添加「自定义工具」
  2. 选择「从 URL 导入 OpenAPI Schema」,粘贴:
OpenAPI Spec URL
https://readgzh.site/.well-known/openapi.yaml
  1. 在鉴权设置中选择「API Key (Bearer)」,填入 Key
  2. 工具会自动解析出 ReadGZH 提供的文章读取操作

FastGPT

  1. 在 FastGPT 应用中添加「HTTP 插件」
  2. 请求方式选择 GET,URL 填入:
API 请求
https://api.readgzh.site/rd?url={{微信文章链接}}
  1. 添加 Header:Authorization: Bearer sk_live_你的Key
  2. 返回类型选择「文本」,即可获取文章 HTML 内容

💡 通用原则:任何支持 OpenAPI/Swagger 导入或 HTTP 请求的 AI 平台, 都可以通过 ReadGZH 的 API 接入微信文章读取能力。 API Key 可在 开发者控制台 免费获取。

API Key 鉴权

API 调用需持有有效授权(API Key)。未授权请求受严格 IP 频率限制(每日仅 10 次), 且不保证服务稳定性。前往 开发者控制台 免费创建 Key,即享每日 30 积分。不写代码的用法见 如何让 AI 读取微信公众号文章

获取 API Key

  1. 前往 开发者控制台,使用邮箱验证码、Google 或 Apple 登录
  2. 点击「创建 Key」生成一个 sk_live_... 格式的密钥
  3. 每天点击「领取今日积分」获取 30 积分
  4. 需要更多积分?查看订阅套餐,Lite ¥9/月起

使用方式

在请求中添加 Authorization 头:

带鉴权的 API 请求
curl "https://api.readgzh.site/rd?url=https://mp.weixin.qq.com/s/xxxxx" \
  -H "Authorization: Bearer sk_live_你的Key"

错误响应

401

未提供 API Key 或 Key 无效

402

API Key 积分已用完。响应包含 pricing_urldashboard_url 引导充值

403

功能需要 Pro 套餐(如 ?mode=summary

429

未授权请求超出严格频率限制(每日 10 次),请注册获取 API Key

📋 使用须知

  • 支持微信公众号普通图文文章和图片消息(小绿书)两种格式
  • 仅支持微信公众号链接(mp.weixin.qq.com)
  • 文章内容会自动缓存,重复请求不会重新抓取
  • 图片消息会提取所有图片和文字描述
  • 网页版免费使用;API 调用需持有 API Key(未授权请求受严格频率限制),免费用户每日 30 积分(需领取),订阅用户每月最高 2,000 积分(自动发放)
  • 请遵守相关法律法规,仅用于个人学习和研究

MCP 服务端地址:https://api.readgzh.site/mcp-server

← 返回首页

© Mzu · readgzh.site