跳到主要内容

API

Gety 提供 REST API，用于程序化搜索。你可以用它来构建自定义集成、连接 AI agent，或从脚本调用 Gety。

设置​

  1. 打开 Gety → 设置 → AI 集成，在 更多方式 下点击 API

Gety AI 集成 页面，显示 更多方式 下的 API Gety → 设置 → AI 集成：点击 更多方式 下的 API

  1. 输入集成名称，点击 创建

添加 API Integration 对话框，包含名称输入框 给你的集成起个名字 — 方便后续识别

  1. Gety 会生成你的 API 文档。你可以浏览各个端点找到需要的接口，或点击 复制全部 复制完整文档交给你的 coding agent 来帮你开发。

API 文档对话框，显示 Base URL、API Key 和端点信息 你的 API 文档 — 点击 复制全部 复制全部内容

快速开始​

一个请求即可搜索你的文件：

curl -X POST "http://127.0.0.1:31226/api/v1/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"query": "会议纪要", "limit": 10}'
交给 AI agent

复制完整的 API 文档，粘贴到 agent 的对话中。两种用法：

  • 直接使用 — 让 agent 替你调用 API："这是我的 Gety 搜索 API，当我让你搜索文件时请使用它。"
  • 开发集成 — 让 coding agent 将 Gety 集成到你的应用中："这是 Gety API 文档，帮我开发一个搜索本地文件的功能。"

无论哪种方式，agent 都能直接上手。

认证​

所有请求需要在 Authorization 头中携带 Bearer token：

Authorization: Bearer sk-gety-api-xxxxx

每个集成有独立的 API Key。你可以在 Gety → 设置 → AI 集成 中创建多个集成。

接口说明​

搜索文档​

POST /api/v1/search

搜索所有已索引的文件。

请求体：

参数类型必填默认值说明
querystring是—搜索文本。使用关键词查询效果最佳。
limitnumber否10最大结果数
semantic_searchboolean否true启用语义搜索以理解上下文含义，或禁用以进行精确关键词匹配
connector_names_filterstring[]否全部按连接器名称过滤（如 ["Folder: Documents"]）
update_time_filterobject否—按时间范围过滤。使用 from 和 to 字段，ISO 8601 格式
sort_bystring否"default""default"（按相关性）或 "update_time"
sort_orderstring否"descending""ascending" 或 "descending"

示例：

curl -X POST "http://127.0.0.1:31226/api/v1/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "query": "季度预算报告",
    "limit": 5,
    "semantic_search": true
  }'

获取文档​

GET /api/v1/connectors/{connector_id}/docs/{doc_id}

获取指定文档的完整内容。使用搜索结果中返回的 connector_id 和 doc_id。

示例：

curl "http://127.0.0.1:31226/api/v1/connectors/CONNECTOR_ID/docs/DOC_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

下载原始文件​

GET /api/v1/connectors/{connector_id}/docs/{doc_id}/file

下载文档的原始文件。

示例：

curl "http://127.0.0.1:31226/api/v1/connectors/CONNECTOR_ID/docs/DOC_ID/file" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o downloaded-file.pdf

列出连接器​

GET /api/v1/connectors

列出所有可用的连接器（已索引的文件夹和数据源）。

示例：

curl "http://127.0.0.1:31226/api/v1/connectors" \
  -H "Authorization: Bearer YOUR_API_KEY"

错误码​

错误码含义
UNAUTHORIZEDAPI Key 无效或缺失
REQUEST_VALIDATION_FAILED请求参数无效
RESOURCE_NOT_FOUND文档或连接器未找到
QUOTA_EXCEEDED免费版额度已用完
DATA_SHARING_DECLINED用户拒绝了数据共享请求
INTERNAL_ERROR服务器错误
最后于 更新