← Обзор / ai-search / api / instances
REST API
Используйте REST API AI Search, чтобы управлять экземплярами и заданиями синхронизации по HTTP.
Аутентификация
Для всех запросов требуется токен API с AI Search:Edit и AI Search:Run разрешения.
-
В панели управления Cloudflare перейдите в My Profile > API-токены.
Перейдите в API-токены ↗ -
Выберите Create Token.
-
Выберите Create Custom Token.
-
Введите Имя токена, например
AI Search Manager. -
В разделе Разрешения, добавьте два разрешения:
- Аккаунт > AI Search:Edit
- Аккаунт > AI Search:Run
-
Выберите Continue to summary, затем выберите Create Token.
-
Скопируйте и сохраните значение токена. Это ваш
API_TOKEN.
Включите токен в Authorization заголовок для всех запросов:
Authorization: Bearer <API_TOKEN>Пути API
API AI Search доступны по двум базовым путям:
| Путь | Описание |
|---|---|
/accounts/{account_id}/ai-search/instances/{id} |
Работает с конкретным экземпляром |
/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id} |
Работает с экземплярами в пределах пространство имён |
Доступные операции одинаковы для обоих путей. Для API в контексте пространства имён см. Справочник по API пространства имён.
Экземпляры
Создавайте, получайте список, извлекайте, обновляйте и удаляйте экземпляры AI Search. Полную спецификацию см. в Справочник по API экземпляров.
| Операция | Метод | Описание |
|---|---|---|
| Создание | POST |
Создайте новый экземпляр |
| Список | GET |
Получить список всех экземпляров |
| Получить | GET |
Получить экземпляр по ID |
| Обновление | PUT |
Обновление конфигурации экземпляра |
| Удалить | DELETE |
Удаление экземпляра |
| Статистика | GET |
Получить статистику индексирования |
Пример: создание экземпляра
Создайте экземпляр в пространстве имён по умолчанию:
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"id": "my-instance"
}'Задания
Запускайте и отслеживайте задания синхронизации которые сканируют ваш источник данных и индексируют новое или обновлённое содержимое. Полную спецификацию см. в Справочник по API заданий.
| Операция | Метод | Описание |
|---|---|---|
| Создание | POST |
Запуск нового задания синхронизации |
| Список | GET |
Получить список всех заданий для экземпляра |
| Получить | GET |
Получить сведения о задании |
| Журналы | GET |
Просмотр журналов заданий |
Пример: запуск задания синхронизации
Запустите новое задание синхронизации для экземпляра:
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/jobs" \
-H "Authorization: Bearer <API_TOKEN>"