API ИИ-агентов

ИИ-агент — это единая сущность, которая содержит контекст, системный промпт и ссылки на набор товаров, базу знаний и API-интеграцию. Агент создаётся один раз и выбирается на канале. Это эволюция прежних «контекстов»: контекст и промпт теперь хранятся прямо в агенте.

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

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

Структура агента

JSON
{
  "id": "uuid",
  "name": "Название",
  "context": "Описание компании, ценности, политика доставки и т.п.",
  "prompt": "Дополнительный системный промпт (опционально)",
  "productsSetId": "uuid | null",
  "knowledgeBaseId": "uuid | null",
  "apiIntegrationId": "uuid | null"
}
  • name — обязательно, до 255 символов.
  • context — текст контекста (подставляется в ответы оператора), опционально.
  • prompt — опциональный системный промпт.
  • productsSetId / knowledgeBaseId / apiIntegrationId — ссылки на привязанный к агенту набор товаров, базу знаний и API-интеграцию. Заполняются автоматически, когда вы создаёте соответствующий ресурс с полем agentId (см. разделы Наборы товаров, Базы знаний, API-интеграции).

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

GET /api/ai-agents/external/agents

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

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

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

Создание

POST /api/ai-agents/external/agents

В теле задаются name, context и prompt. Набор товаров, база знаний и API-интеграция привязываются отдельно — при их создании укажите agentId этого агента.

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

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

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-agents/external/agents/{id}
  • PATCH /api/ai-agents/external/agents/{id} — частичное обновление (name, context, prompt)
  • DELETE /api/ai-agents/external/agents/{id}?confirmed=true — каскадно снимает агента с привязанных каналов

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

GET /api/ai-agents/external/agents/{id}/channels

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

Выбор ИИ-агента на канале

После создания агента выберите его на канале через настройки AI-оператора канала.