AutoAiSeo API 与 MCP
通过您自己的软件(REST API)或 Claude、ChatGPT、Cursor 等 AI 助手(MCP)使用 AutoAiSeo 数据。每个请求只能访问您自己账户的数据。
快速入门
- 在控制台中打开 API 与 MCP 标签页,然后通过 新建密钥 创建一个密钥。密钥(
rk_live_…)仅显示一次。 - 在请求中通过
Authorization: Bearer请求头发送密钥。
curl -H "Authorization: Bearer rk_live_…" https://autoaiseo.example/api/v1/sites
基础地址: https://autoaiseo.example/api/v1。所有响应均为 JSON;成功的响应在 data 字段中返回。
身份验证与权限
| 权限 | 可执行的操作 |
|---|---|
read (读取) | 账户、网站、文章、关键词、外链报告、进展和服务记录。 |
read_write (读写) | 此外还可添加文章选题、撰写文章(从套餐的每月配额中扣除)以及发布文章。 |
- 每个账户最多 10 个有效密钥。密钥可设为永久有效,或有效期 30 天、90 天、1 年。
- AutoAiSeo 不会保存密钥本身,只保存其 SHA-256 摘要和显示前缀(
rk_live_Ab3dEf)。丢失的密钥无法找回;请撤销后新建一个。 - 已吊销、已过期或属于已停用账户的密钥将立即失效。
- 浏览器会话 Cookie 对 API 无效;每次请求都必须发送密钥。
速率限制
每个密钥(或 OAuth 连接)每分钟 60 次请求。响应中包含 X-RateLimit-Limit 和 X-RateLimit-Remaining 响应头。超出限制时,将返回 429 ,以及告知需等待多少秒的 Retry-After 响应头。
错误
{ "error": { "code": "not_found", "message": "Site bulunamadı" } }
| HTTP | code | 含义 |
|---|---|---|
| 400 | invalid_request | 参数或请求体无效。 |
| 401 | unauthorized, invalid_token | 密钥缺失、无效、已吊销或已过期。 |
| 402 | quota_exceeded | 本月文章配额已用完。 |
| 403 | insufficient_scope | 此操作需要“读写”权限。 |
| 403 | account_suspended | 账户已被停用。 |
| 404 | not_found | 记录不存在或不属于您。 |
| 409 | conflict, not_ready, limit_reached | 文章已在撰写中/已上线、尚不能发布,或已达到某项限制。 |
| 429 | rate_limited | 已超出速率限制。 |
| 502 | publish_failed | 发布目标(WordPress、Shopify…)未接受此次发布。 |
| 500 | internal_error | 意外的服务器错误。 |
分页
长列表接受 page 和 per_page (最多 100–200)参数,并返回以下信息:
"pagination": { "page": 1, "per_page": 50, "total": 132, "total_pages": 3 }
端点
GET /api/v1/me
账户、套餐限额、本月用量、额外外链额度以及所用密钥的权限。
GET /api/v1/sites
您的网站: id、域名、状态、SEO 健康分、信任分、已上线文章、有效外链、引用域名、30 天变化以及下一篇文章。
GET /api/v1/sites/{id}
网站概览:资料、发布设置、文章数量(按状态)、外链网络概览以及 30 天进展概览。
GET /api/v1/sites/{id}/progress?range=90d
进展报告。 range: 30d, 90d, 180d, 365d, all.
GET /api/v1/sites/{id}/articles
文章(分页)。参数: status (planned, generating, review, approved, published, failed), q (按标题/关键词搜索)、 page, per_page.
GET /api/v1/articles/{id}
文章:标题、meta 描述、评分(SEO、GEO、可读性)、常见问题、合作外链、正文链接(内部/外部/合作)以及内容。 content: html (默认)、 markdown 或 none.
GET /api/v1/sites/{id}/keywords
关键词(分页):集群、搜索意图、优先级以及针对该关键词的文章(article_id, article_status)。参数: cluster, q, page, per_page.
GET /api/v1/sites/{id}/backlinks
外链报告:积分、有效/待处理链接、引用域名、锚文本分布、获得的链接(分页)以及最近给出的链接。
GET /api/v1/sites/{id}/services
AutoAiSeo 为网站完成的工作:总计、近 12 个月和历史记录(每页 30 条)。参数: kind, q, page.
POST /api/v1/sites/{id}/articles read_write
向内容计划添加文章选题(状态为 planned)。未指定日期时,将排在计划中最后一篇文章的次日;到期后由 AutoAiSeo 撰写。不占用配额。
curl -X POST -H "Authorization: Bearer rk_live_…" -H "Content-Type: application/json" \
-d '{"title":"Filtre kahve nasıl demlenir?","target_keyword":"filtre kahve demleme","angle":"Yeni başlayanlar için"}' \
https://autoaiseo.example/api/v1/sites/12/articles
请求体: title (必填,5–200)、 target_keyword, cluster, angle, scheduled_for (YYYY-MM-DD)。响应 201.
POST /api/v1/articles/{id}/generate read_write
在后台撰写文章(202,状态为 generating)。规则与控制台相同:从每月配额中扣除(重写本月已撰写的文章免费),已上线的文章不能重写。完成后状态变为 review olur.
POST /api/v1/articles/{id}/publish read_write
将已撰写的文章发送到网站的发布目标(AutoAiSeo 博客、WordPress、Shopify、Webflow、webhook),并返回发布地址。
MCP 服务器
地址: https://autoaiseo.example/mcp — Streamable HTTP 传输层(JSON 响应)。协议版本: 2026-07-28 以及需握手的旧版本(2025-11-25, 2025-06-18, 2025-03-26).
身份验证可通过以下两种方式之一进行:
- OAuth — 在 Claude 和 ChatGPT 等连接器中添加该地址后,AutoAiSeo 会打开登录和授权页面,无需 API 密钥。您可以在控制台的 已连接应用中移除连接。
- API 密钥 — 适用于 Cursor、Claude Code、VS Code 等客户端,使用
Authorization: Bearer rk_live_…请求头。
Claude
设置 → 连接器 → 添加自定义连接器:将 MCP 地址粘贴为 URL,然后点击 连接按钮。
ChatGPT
设置 → 应用与连接器 → 高级设置中开启开发者模式, 创建连接器 时填入 MCP 地址并选择 OAuth 身份验证。
Cursor(~/.cursor/mcp.json)
{
"mcpServers": {
"autoaiseo": {
"url": "https://autoaiseo.example/mcp",
"headers": { "Authorization": "Bearer rk_live_…" }
}
}
}
Claude Code
claude mcp add --transport http autoaiseo https://autoaiseo.example/mcp --header "Authorization: Bearer rk_live_…"
MCP 工具
工具结果包含一段简短的文字摘要,以及同一数据的结构化形式(structuredContent)。仅在授予写入权限时才会列出写入工具。
| 工具 | 功能 |
|---|---|
list_sites | 网站及汇总指标,以及其他工具所需的 site_id. |
site_overview | 网站资料、指标、文章数量、外链网络概览。 |
site_progress | 某一时期的进展报告(起点与现状、里程碑)。 |
list_articles | 文章;可按状态和文本筛选,分页。 |
get_article | 文章内容(markdown/HTML)、评分、链接、常见问题。 |
list_keywords | 关键词及覆盖它们的文章。 |
backlink_report | 外链网络报告及获得的链接。 |
services_history | AutoAiSeo 工作明细。 |
add_article_idea yazma | 向内容计划添加文章选题。 |
generate_article yazma | 撰写文章(从配额中扣除)。 |
publish_article yazma | 发布文章。 |
OAuth(面向 MCP 客户端开发者)
AutoAiSeo 内置一个符合 MCP 授权规范的轻量级 OAuth 2.1 授权服务器。
| 受保护资源元数据 | /.well-known/oauth-protected-resource (以及带 /mcp 后缀路径) |
| 授权服务器元数据 | /.well-known/oauth-authorization-server |
| 客户端注册 | Client ID Metadata Documents(https client_id)或动态注册: POST /oauth/register (仅限公共客户端, token_endpoint_auth_method: none) |
| 授权 | GET /oauth/authorize — response_type=code,PKCE S256 zorunlu, resource (RFC 8707),响应中包含 iss (RFC 9207) |
| 密钥 | POST /oauth/token — authorization_code 和 refresh_token |
| 取消 | POST /oauth/revoke (RFC 7009) |
| 范围 | read, write (写入权限包含读取)。用户在授权页面选择权限级别。 |
- 重定向地址必须为 https 或
localhost/127.0.0.1地址,且必须完全一致(环回地址的端口不限)。 - 授权码有效期为 2 分钟,且只能使用一次;第二次使用将撤销该连接的所有令牌。
- 访问令牌有效期为 1 小时,刷新令牌为 30 天。刷新令牌每次使用后都会更换;重复使用旧的刷新令牌将关闭该连接。
- 访问令牌仅签发给 MCP 服务器使用;REST API 需要个人 API 密钥。
- 权限范围不足时返回
403和WWW-Authenticate: Bearer error="insufficient_scope", scope="read write"响应头。
隐私
您在控制台中看到的 API 活动记录仅包含请求方法、路径、状态码、耗时、密钥的显示前缀(或 OAuth 应用名称)和时间。不会记录请求和响应内容以及 IP 地址;每个账号保留最近 1,000 条请求。