跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

REST API

最后更新 查看 MarkdownAgent 设置

使用 AI Search REST API 在实例中上传、列出和管理单个文档。

认证

所有请求都需要具有 AI Search:Edit 和 AI Search:Run 权限的 API token。

  1. 在 Cloudflare 仪表板中,前往 My Profile(我的个人资料) > API Tokens(API 令牌)。

    前往 API Tokens(API 令牌) ↗
  2. 选择 Create Token(创建令牌)。

  3. 选择 Create Custom Token(创建自定义令牌)。

  4. 输入 Token name(令牌名称),例如 AI Search Manager。

  5. 在 Permissions(权限) 下,添加两项权限:

    • Account > AI Search:Edit
    • Account > AI Search:Run
  6. 选择 Continue to summary(继续查看摘要),然后选择 Create Token(创建令牌)。

  7. 复制并保存 token 值。这就是你的 API_TOKEN。

在所有请求的 Authorization header 中包含该 token:

Authorization: Bearer <API_TOKEN>

API 路径

条目 API 的作用范围限定为一个命名空间:

路径 描述
/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/ 对命名空间中的实例执行操作

每个账户都有一个 default 命名空间。如果尚未创建自定义命名空间,请使用 default。完整规范请参阅命名空间 API 参考。

条目

在实例中上传、列出、获取、删除和下载项目。完整规范请参阅 Items API reference。

操作 方法 描述
上传 POST 上传文档以进行索引
列出 GET 列出实例中的所有项目
获取 GET 按 ID 获取项目信息
删除 DELETE 删除项目
下载 GET 下载原始文件

示例:上传文档

将文件上传到实例:

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/<INSTANCE_NAME>/items" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -F "file=@/path/to/your/file.pdf"

示例:列出项目

列出实例中的所有项目:

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/<INSTANCE_NAME>/items" \
  -H "Authorization: Bearer <API_TOKEN>"

要按确切的对象键查找单个项目,请传入 key 查询参数:

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/<INSTANCE_NAME>/items?key=docs/readme.md" \
  -H "Authorization: Bearer <API_TOKEN>"

键在每个数据源内唯一,因此当同一键存在于多个源时,请将 key 与 source 结合使用(例如 source=builtin)以消除歧义。

这篇文档对您有帮助吗?