API контекстов AI

Контекст — это общее описание компании/домена, которое подставляется в каждый запрос AI оператора. Контексты создаются один раз и привязываются к каналу через настройки AI оператора.

Токен должен иметь scope ai_contexts.

Базовый URL: https://api.apx.chat/api

Структура контекста

JSON
{
  "id": "uuid",
  "name": "Название",
  "context": "Описание компании, ценности, политика доставки и т.п.",
  "prompt": "Дополнительный системный промпт (опционально)"
}
  • name — обязательно, до 255 символов.
  • context — текст контекста (подставляется в ответы оператора).
  • prompt — опциональный системный промпт.

Получение списка

GET /api/ai-resources/external/contexts

const url = "https://api.apx.chat/api/ai-resources/external/contexts";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-Api-Token": "tok_xxxxx",
  },
});

const data = await response.json();
console.log(data);

Создание

POST /api/ai-resources/external/contexts

const url = "https://api.apx.chat/api/ai-resources/external/contexts";

const payload = {
"name": "Основной контекст",
"context": "Мы продаём электронику, доставка по РФ за 24 часа."
};

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-Api-Token": "tok_xxxxx",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

const data = await response.json();
console.log(data);

Получение / обновление / удаление

  • GET /api/ai-resources/external/contexts/{id}
  • PATCH /api/ai-resources/external/contexts/{id} — частичное обновление
  • DELETE /api/ai-resources/external/contexts/{id}?confirmed=true — каскадно снимает контекст с привязанных каналов

Каналы, использующие контекст

GET /api/ai-resources/external/contexts/{id}/channels

Возвращает список каналов, у которых выбран этот контекст. Полезно перед удалением.

Привязка к каналу

После создания контекста его нужно привязать к каналу через настройки AI оператора канала.