REST API

AI Search REST API を使い、HTTP 経由でインスタンスと同期ジョブを管理します。

認証

すべてのリクエストには、AI Search:Edit と AI Search:Run の権限を持つ API トークンが必要です。

Cloudflare ダッシュボードで My Profile > API Tokens を開きます。
API Tokens を開く ↗
Create Token を選択します。
Create Custom Token を選択します。
Token name を入力します。例: AI Search Manager
Permissions で次の 2 つの権限を追加します。
- Account > AI Search:Edit
- Account > AI Search:Run
Continue to summary を選択し、続けて Create Token を選択します。
トークンの値をコピーして保存します。これが API_TOKEN です。

すべてのリクエストの Authorization ヘッダーにトークンを含めます。

Authorization: Bearer <API_TOKEN>

API パス

AI Search は Instance API を namespace にスコープします。

パス	説明
`/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}`	namespace 内のインスタンスを操作します

すべてのアカウントに default namespace があります。カスタム namespace を作っていない場合は default を使います。仕様の全体は Namespace API リファレンスを参照してください。

インスタンス

AI Search インスタンスの作成、一覧、取得、更新、削除を行います。仕様の全体は Instances API リファレンスを参照してください。

操作	メソッド	説明
Create	`POST`	新しいインスタンスを作成します
List	`GET`	すべてのインスタンスを一覧します
Get	`GET`	ID でインスタンスを取得します
Update	`PUT`	インスタンスの設定を更新します
Delete	`DELETE`	インスタンスを削除します
Stats	`GET`	インデックスの統計を取得します

例: インスタンスを作成する

デフォルトの namespace にインスタンスを作成します。

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "my-instance"
  }'

ジョブ

データソースをスキャンし、新規または更新されたコンテンツをインデックスする同期ジョブを起動し、監視します。仕様の全体は Jobs API リファレンスを参照してください。

操作	メソッド	説明
Create	`POST`	新しい同期ジョブを起動します
List	`GET`	インスタンスのすべてのジョブを一覧します
Get	`GET`	ジョブの詳細を取得します
Logs	`GET`	ジョブのログを表示します

例: 同期ジョブを起動する

インスタンスの新しい同期ジョブを開始します。

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