开发者
API 路由清单
全部公开 REST 端点，由运行中的路由表生成，并标注认证方式与 scope。
由 createApp() 生成——与 API server 运行的路由表同源。平台/管理员/webhook 等内部端点已排除。
Base URL： https://app.aieo.ee/api · 认证： Authorization: Bearer aieo_...（API key）或 dashboard 会话 cookie。
使用 API key 的写操作（POST/PATCH/DELETE）需要 write scope；只读 key 会得到 403。API key 始终作用于其所属组织；x-org-id 是面向多组织成员的会话认证功能，不能切换 API key 的组织。
核心流程的手写请求/响应示例将在下一文档阶段补充；本清单是完整的、自动生成的接口面。
AI 可见性（GEO）
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
DELETE | /api/projects/:projectId/geo/prompts/:promptId | 会话或 API key | 删除跟踪 prompt。 |
GET | /api/projects/:projectId/geo/citations | 会话或 API key | AI 引擎在跟踪 prompt 中引用了哪些域名。 |
GET | /api/projects/:projectId/geo/engines | 会话或 API key | 分引擎可见性汇总（聚合混算 live 与 sampled runs）。 |
GET | /api/projects/:projectId/geo/prompts | 会话或 API key | 跟踪 prompt 列表及逐 prompt 统计。 |
GET | /api/projects/:projectId/geo/runs | 会话或 API key | GEO 运行历史（按 prompt×engine×day）。 |
GET | /api/projects/:projectId/geo/runs/:runId | 会话或 API key | 单次 GEO 运行详情：原始回答、提及、引用。 |
GET | /api/projects/:projectId/geo/series | 会话或 API key | 按日可见性时间序列（图表用）。 |
GET | /api/projects/:projectId/geo/sov | 会话或 API key | AI 回答中各品牌的 share of voice。 |
GET | /api/projects/:projectId/geo/summary | 会话或 API key | AI 可见性摘要：回溯窗口内的提及率、引用率（?days）。 |
PATCH | /api/projects/:projectId/geo/prompts/:promptId | 会话或 API key | 更新 prompt（text/engines/active；cadence 仅创建时设置）。 |
POST | /api/projects/:projectId/geo/prompts | 会话或 API key | 创建跟踪 prompt（文本、分类、引擎、节奏）。 |
POST | /api/projects/:projectId/geo/prompts/:promptId/run | 会话或 API key | 立即在所选引擎上运行一个 prompt（每 prompt×engine 扣 1 credit，受配额检查）。 |
POST | /api/projects/:projectId/geo/run-all | 会话或 API key | 立即运行全部启用 prompt（credit + 每日配额预检）。 |
SEO 情报
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
DELETE | /api/projects/:projectId/seo/keywords/:keywordId | 会话或 API key | 移除跟踪关键词。 |
GET | /api/projects/:projectId/seo/backlink-gap | 会话或 API key | 竞对拥有而本项目缺失的反链。 |
GET | /api/projects/:projectId/seo/backlinks | 会话或 API key | 反链概况与头部链接。 |
GET | /api/projects/:projectId/seo/competitor-discovery | 会话或 API key | 从存量 SERP 快照发现共同出现的竞对（重叠分）。 |
GET | /api/projects/:projectId/seo/competitor-discovery/:domain/keywords | 会话或 API key | 单个被发现竞对的共现关键词下钻。 |
GET | /api/projects/:projectId/seo/competitors | 会话或 API key | 竞对矩阵：重叠度与排名对比。 |
GET | /api/projects/:projectId/seo/competitors/missing | 会话或 API key | 竞对有排名而本项目没有的关键词（?brandId）。 |
GET | /api/projects/:projectId/seo/distribution | 会话或 API key | 累计排名桶（top3、top10、top20、top100）。 |
GET | /api/projects/:projectId/seo/domain-overview | 会话或 API key | 项目已跟踪关键词的聚合视图：排名摘要、估算流量、top pages、SERP 特性、已存储反链与竞对矩阵。 |
GET | /api/projects/:projectId/seo/intersection | 会话或 API key | 全部所选竞对（2–4 个）最近 10 天内均进 top-20 的关键词，附各竞对排名。 |
GET | /api/projects/:projectId/seo/keyword-gap | 会话或 API key | 对选定竞对的关键词差距。 |
GET | /api/projects/:projectId/seo/keywords | 会话或 API key | 跟踪关键词表：排名、搜索量、难度、意图。 |
GET | /api/projects/:projectId/seo/serp | 会话或 API key | 单关键词实时 SERP 查询（按需调用数据源）。 |
GET | /api/projects/:projectId/seo/serp-features | 会话或 API key | 最近 7 天 SERP 特性统计（仅演示模式启发式标记；真实特性检测未接入）。 |
GET | /api/projects/:projectId/seo/summary | 会话或 API key | SEO 头部指标（平均排名、跟踪关键词数、估算流量）。 |
POST | /api/projects/:projectId/competitors | 会话或 API key | 为项目添加竞对品牌/域名。 |
POST | /api/projects/:projectId/seo/keywords | 会话或 API key | 添加跟踪关键词（受套餐限制）。 |
POST | /api/projects/:projectId/seo/refresh | 会话或 API key | 为项目排队一次排名刷新。 |
POST | /api/projects/:projectId/seo/research | 会话或 API key | 种子词关键词研究（配置 DataForSEO 时使用真实数据）。 |
Search Console 与集成
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
DELETE | /api/projects/:projectId/integrations/gsc | 会话，仅组织 owner/admin | 断开 GSC（清除已存指标）。 |
GET | /api/projects/:projectId/integrations/gsc | 会话或 API key | 项目 GSC 连接状态。 |
GET | /api/projects/:projectId/integrations/gsc/auth-url | 会话，仅组织 owner/admin | 发起 GSC OAuth（一次性 state URL）。 |
GET | /api/projects/:projectId/search-analytics/rows | 会话或 API key | GSC 按 query 或 page 维度的明细行（窗口内聚合，CTR/排名按展示加权）。 |
GET | /api/projects/:projectId/search-analytics/summary | 会话或 API key | Google Search Console 摘要（点击、展示、CTR、排名）。 |
PATCH | /api/projects/:projectId/integrations/gsc | 会话，仅组织 owner/admin | 更新 GSC 连接设置（站点 URL）。 |
POST | /api/projects/:projectId/integrations/gsc/confirm | 会话，仅组织 owner/admin | OAuth 后确认站点选择（pending_token 流程）。 |
POST | /api/projects/:projectId/integrations/gsc/sync | 会话或 API key | 触发 GSC 数据同步（按日拉取，3 天强制重拉）。 |
内容缺口与 Brief
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /api/projects/:projectId/content/briefs | 会话或 API key | 列出已生成的内容 brief。 |
GET | /api/projects/:projectId/content/briefs/:briefId | 会话或 API key | 单个内容 brief（大纲、实体、FAQ）。 |
GET | /api/projects/:projectId/content/gaps | 会话或 API key | 内容缺口：竞对 top-10 有排名而本项目没有的关键词。 |
POST | /api/projects/:projectId/content/gaps/:gapId/brief | 会话或 API key | 为一个缺口生成内容 brief（预扣 credits，失败退款）。 |
POST | /api/projects/:projectId/content/recompute-gaps | 会话或 API key | 基于当前排名重新计算内容缺口。 |
技术审计
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /api/projects/:projectId/audit/latest | 会话或 API key | 最近一次审计运行及评分问题。 |
POST | /api/projects/:projectId/audit | 会话或 API key | 排队一次技术 SEO 站点审计（爬虫，maxPages）。 |
Growth Agent 与建议
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /api/projects/:projectId/agent/conversations | 会话或 API key | 列出 Growth Agent 会话。 |
GET | /api/projects/:projectId/agent/conversations/:conversationId/messages | 会话或 API key | 单个会话的消息列表。 |
GET | /api/projects/:projectId/recommendations | 会话或 API key | 项目的优先级增长建议。 |
PATCH | /api/projects/:projectId/recommendations/:recId | 会话或 API key | 更新建议状态（完成/忽略）。 |
POST | /api/projects/:projectId/agent/analyze | 会话或 API key | 运行完整诊断分析（按 credit 计费）。 |
POST | /api/projects/:projectId/agent/chat | 会话或 API key | 向 Growth Agent 发消息（按 credit 计费，provider 失败退款）。 |
POST | /api/projects/:projectId/agent/conversations | 会话或 API key | 创建 Growth Agent 会话。 |
组织、API Key 与账单
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
DELETE | /api/org/keys/:keyId | 会话，仅组织 owner/admin | 吊销 API key——仅 owner/admin。 |
GET | /api/org | 会话或 API key | 当前组织概况：套餐、权益、席位数。 |
GET | /api/org/billing/invoices | 会话，仅组织 owner/admin | Stripe 发票历史。 |
GET | /api/org/billing/preview-change | 会话，仅组织 owner/admin | 预览换套餐：行级 proration（30 分钟新鲜度）。 |
GET | /api/org/billing/session-status | 会话，仅组织 owner/admin | 轮询 checkout 会话完成状态。 |
GET | /api/org/invitations | 会话，仅组织 owner/admin | 列出待处理成员邀请——仅 owner/admin。 |
GET | /api/org/keys | 会话或 API key | 列出组织 API keys（脱敏）。 |
GET | /api/org/usage | 会话或 API key | 当前周期用量 vs 套餐限额（runs、briefs、关键词、credits）。 |
PATCH | /api/org | 会话，仅组织 owner/admin | 更新组织设置（名称等）——仅 owner/admin 会话。 |
POST | /api/org/billing/cancel | 会话，仅组织 owner/admin | 取消订阅（周期末或立即，按请求体）。 |
POST | /api/org/billing/change-plan | 会话，仅组织 owner/admin | 执行已预览的换套餐（always_invoice + proration_date）。 |
POST | /api/org/billing/checkout | 会话，仅组织 owner/admin | 为套餐创建 Stripe Checkout 会话（按席位数量）。 |
POST | /api/org/billing/portal | 会话，仅组织 owner/admin | 打开 Stripe Billing Portal 会话（发票、支付方式）。 |
POST | /api/org/billing/resume | 会话，仅组织 owner/admin | 恢复待取消的订阅。 |
POST | /api/org/billing/topup | 会话，仅组织 owner/admin | 一次性 credit 充值结账。 |
POST | /api/org/keys | 会话，仅组织 owner/admin | 创建 API key（可选 read+write scope）——仅 owner/admin。 |
POST | /api/org/leave | 会话 cookie | 退出组织（最后一位 owner 拒绝；同步席位数量）。 |
POST | /api/org/transfer-ownership | 会话，仅组织 owner/admin | 原子化转让组织所有权（org 锁 + 角色互换）。 |
项目与总览
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /api/projects | 会话或 API key | 列出当前组织的项目（网站）。 |
GET | /api/projects/:projectId/overview | 会话或 API key | 仪表盘总览：Growth Score 输入、趋势亮点。 |
GET | /api/projects/:projectId/overview/report | 会话或 API key | 项目白标 HTML 增长报告。 |
POST | /api/projects | 会话或 API key | 创建项目（域名、名称）——受套餐限制。 |
账号与通知
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /api/account/export | 会话 cookie | 导出账号个人数据（GDPR 风格 JSON）。 |
GET | /api/notifications | 仅会话（不接受 API key） | 列出当前用户的站内通知（API key 拒绝访问）。 |
GET | /api/notifications/unread-count | 仅会话（不接受 API key） | 未读通知数。 |
PATCH | /api/account/preferences | 会话 cookie | 设置账号语言（'en' | 'zh'），驱动界面与事务邮件语言。 |
POST | /api/account/delete | 会话 cookie | 删除账号（取消 Stripe 订阅、级联清理独占组织数据；存在共享组织时 409）。 |
POST | /api/notifications/mark-read | 仅会话（不接受 API key） | 标记通知已读（按 ids 或全部）。 |
免费工具
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
POST | /api/tools/robots | 会话或 API key | 免费工具：抓取并解析站点 robots.txt。 |
POST | /api/tools/schema | 会话或 API key | 免费工具：从 URL 提取结构化数据（schema.org）。 |
POST | /api/tools/serp | 会话或 API key | 免费工具：对查询做实时 SERP 检查（DataForSEO 或 mock 池）。 |
POST | /api/tools/sitemap | 会话或 API key | 免费工具：抓取并汇总站点 sitemap。 |
元信息
| 方法 | 路径 | 认证 | 说明 |
|---|---|---|---|
GET | /health | 公开 | 存活探针：服务名与当前配置的 AI 引擎 ID 列表。 |