Изменить промпт агента, его состояние вкл/выкл или опции

PATCH
/api/bot/flows/{flowId}/agents/{name}

Отправьте любое подмножество полей.

  • enabled применяется только к spam, operator, editor, translator, summary; default работает всегда, а активация сценария — не переключатель, который открывает этот API (в обоих случаях 400).
  • prompt применяется к default, spam, operator, editor, summary и к любому сценарию; у translator нет инструкции (400).
  • options.workAsSkill и options.description применяются только к сценарию, options.languages — к translator, options.minClientMessages — к summary. Остальные ключи опций применяются к тому агенту, который был адресован, и должны быть булевыми.

Записывает события бота agent_enable/agent_disable или agent_options_change; изменение промпта событий не создаёт.

Authorization

ApiKeyAuth
Authorization<token>

API-ключ интеграции со страницы бота Settings → API Keys, передаётся как есть, без префикса Bearer.

In: header

Path Parameters

flowId*integer

Id агента из GET /api/bot/flows.

name*string

Имя агента в том виде, в каком его возвращает GET /api/bot/flows/{flowId}/agents — например, default, spam, scenario_refunds. Адресация по имени, а не по id, потому что у служебного агента ещё может не быть строки в БД.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Любое подмножество полей; ожидается хотя бы одно значимое изменение.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/bot/flows/0/agents/scenario_refunds" \  -H "Content-Type: application/json" \  -d '{    "dryRun": true,    "prompt": "New instruction text",    "options": {      "workAsSkill": false    }  }'
{  "applied": true,  "changes": [    {      "field": "options.workAsSkill",      "oldValue": null,      "newValue": null    }  ]}