使用 AI Search REST API 在实例中上传、列出和管理单个文档。
所有请求都需要具有 AI Search:Edit 和 AI Search:Run 权限的 API token。
-
在 Cloudflare 仪表板中,前往 My Profile(我的个人资料) > API Tokens(API 令牌)。
前往 API Tokens(API 令牌) ↗ -
选择 Create Token(创建令牌)。
-
选择 Create Custom Token(创建自定义令牌)。
-
输入 Token name(令牌名称),例如
AI Search Manager。 -
在 Permissions(权限) 下,添加两项权限:
- Account > AI Search:Edit
- Account > AI Search:Run
-
选择 Continue to summary(继续查看摘要),然后选择 Create Token(创建令牌)。
-
复制并保存 token 值。这就是你的
API_TOKEN。
在所有请求的 Authorization header 中包含该 token:
Authorization: Bearer <API_TOKEN>条目 API 的作用范围限定为一个命名空间:
| 路径 | 描述 |
|---|---|
/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/ |
对命名空间中的实例执行操作 |
每个账户都有一个 default 命名空间。如果尚未创建自定义命名空间,请使用 default。完整规范请参阅命名空间 API 参考。
在实例中上传、列出、获取、删除和下载项目。完整规范请参阅 Items API reference。
将文件上传到实例:
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)以消除歧义。