FlyAI 页面主视觉:蓝紫色科技渐变背景,象征生成式引擎优化的 AI 智能网格
产品文档 / API 参考

FlyAI GEO API 参考

FlyAI GEO REST API 覆盖诊断、内容结构化、Schema 与 llms.txt 生成、引用与提及监测四组接口。所有接口使用 JSON 请求与响应,通过 Bearer Token 认证,遵循 RESTful 设计规范。

认证方式

所有 API 请求需在 HTTP Header 中携带 Authorization: Bearer <API_KEY>。API Key 在控制台「账户设置 → API Key」中生成。

curl https://api.flyai66.top/v1/monitoring?keyword=GEO \
  -H "Authorization: Bearer $FLYAI_API_KEY"

速率限制

套餐每分钟每天
专业版60 次1,000 次
企业版600 次(可协商)不限量

响应头包含 X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset 字段。

接口列表

POST/v1/diagnosis

提交 AI 搜索可见性诊断任务,返回 100+ 维度诊断报告。

请求参数

参数类型必填说明
urlsstring[]是待诊断的 URL 列表,最多 500 个
keywordsstring[]否关注的关键词列表,最多 20 个
enginesstring[]否目标引擎,默认全部 12+ 引擎
POST/v1/structure

将 Markdown/富文本内容转换为引擎友好的结构化格式。

请求参数

参数类型必填说明
contentstring是Markdown 或 HTML 内容
entity_namestring是品牌实体名
formatstring否输出格式:markdown / json-ld
POST/v1/schema

生成指定类型的 Schema.org JSON-LD。

请求参数

参数类型必填说明
typestring是Schema 类型:Organization / WebSite / SoftwareApplication / FAQPage / BreadcrumbList / Article
dataobject是Schema 字段数据
GET/v1/monitoring

查询品牌在 12+ 生成式引擎中的引用与提及数据。

请求参数

参数类型必填说明
keywordstring是查询关键词
enginesstring[]否目标引擎
date_fromstring否开始日期 YYYY-MM-DD
date_tostring否结束日期 YYYY-MM-DD

诊断接口 curl 示例

curl -X POST https://api.flyai66.top/v1/diagnosis \
  -H "Authorization: Bearer $FLYAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://www.flyai66.top", "https://www.flyai66.top/product"],
    "keywords": ["GEO 工具", "AI 搜索优化"]
  }'

错误码

状态码错误码说明
400invalid_request请求参数错误
401unauthorizedAPI Key 无效或缺失
403forbidden套餐不支持该接口
429rate_limited超出速率限制
500internal_error服务器内部错误

本文档的 API 设计遵循 GEO 方法论。方法论见KDD 2024 GEO 论文,RAG 原理参考Lewis et al., NeurIPS 2020。

方法论实证依据

API 参考常见问题

以下是客户在评估 GEO 服务时最常提出的问题;如未找到答案,可联系 FlyAI 销售团队获得一对一解答。

FlyAI GEO API 支持哪些编程语言的 SDK?
FlyAI GEO 提供 Node.js(TypeScript)SDK,其他语言可通过 REST API 直接调用。社区贡献的 Python、Go、Java SDK 可在 GitHub(https://github.com/FlyAI)查看。SDK 与 REST API 功能完全一致。
API 请求超时时间是多少?
单次诊断请求超时时间为 300 秒(5 分钟),结构化与 Schema 生成接口超时 60 秒,监测查询接口超时 30 秒。超时后返回 408 Request Timeout,建议客户端实现退避重试。
如何处理 API 错误?
FlyAI GEO API 使用标准 HTTP 状态码:200 成功、400 参数错误、401 认证失败、403 权限不足、429 限流、500 服务器错误。响应体含 error.code 与 error.message 字段,客户端应根据 code 做差异化处理。
接口是同步还是异步?
提交类接口(诊断、生成)返回任务或记录标识,结果需另行查询;读取类接口同步返回结果。【待确认:各接口的字段名】
接口有幂等性保证吗?
以任务/记录 ID 为准。【待确认:重复提交是新建记录还是复用,请按实际实现填写】
错误码怎么读?
4xx 多为请求参数或鉴权问题,5xx 为服务侧问题;响应体中的 message 字段说明具体原因。