Платформа · API и вебхуки

Интегрируйтесь через HTTPS, а не слайды

Реализуйте сервер-сервер чат, транслируйте токены в свой интерфейс и запускайте автоматизации из вебхуков, которые завершаются на вашем хосте FlexyAgents. Маршруты ниже — реальные обработчики Next.js — скопируйте значения из раздела «Развёртывание» после создания API-подключения FlexyAgents.

  • POST /api/agents/{agentId}/chat принимает Bearer tokens, привязанные к FlexyAgents automation-app connection, затем запускает тот же RAG + model stack, что и widget
  • Опциональный streaming возвращает NDJSON chunks; без streaming ответ — один assistant payload
  • Per-IP rate limits apply до plan checks; hosted plans enforce token budgets, а BYOK возвращает explicit errors при missing provider key
  • Webhook triggers, channel callbacks и outbound integrations делят tenancy model — всё разрешается в organization_id и agent record

Сначала нужны ключи? Создать рабочее пространство и откройте Настройки → API-ключи или модальное окно подключения агента.

HTTP-интерфейсы в обзоре

Пути отражают дерево маршрутов Next.js. Замените заполнители ID агента и хостом с экрана развёртывания.

  • POST/api/agents/{agentId}/chat

    Чат агента и стриминг

    Отправьте JSON body с массивом messages (role + content) и опциональным флагом stream. Bearer auth проверяется против FlexyAgents API key, сохранённого на agent connection; при успешной auth organization_id разрешается автоматически.

  • POST/api/webhooks/automations/...

    Вход триггера автоматизации

    Опубликованные automations могут expose webhook URLs, которые десериализуют payloads и вызывают executeAutomation — полезно, когда ваши сервисы должны запускать flows без OAuth.

  • ПОЛУЧИТЬ/ОТПРАВИТЬ/api/webhooks/*

    Вебхуки каналов и провайдеров

    Sibling routes под /api/webhooks обрабатывают WhatsApp, Instagram, Facebook Messenger, inbound email и аналогичные vendor callbacks, чтобы omnichannel deployments оставались на вашем domain.

  • Интеграции → Вебхуки

    Исходящая доставка

    Настройте signed outbound webhooks из dashboard, когда FlexyAgents должен push conversation или system events в ваш SIEM, data lake или ticketing bridge.

Минимальный вызов без стриминга

curl -X POST "https://ВАШ_ХОСТ/api/agents/ID_АГЕНТА/chat"   -H "Authorization: Bearer ВАШ_КЛЮЧ_API_FLEXYAGENTS"   -H "Content-Type: application/json"   -d '{"messages":[{"role":"user","content":"Здравствуйте"}],"stream":false}'

Замените значениями, скопированными из Развёртывание → API после подключения приложения FlexyAgents к этому агенту.

Вызов

HTTPS-first chat с тем же «мозгом», что у widget

Deployment screen копирует curl snippet против вашего live host. Handler валидирует API keys через automation connection store, загружает behavior + knowledge и increment usage, как любой другой channel.

  • Контракт messages array

    Body должен включать минимум один chat turn. Executor trim history до последнего user message для retrieval, но принимает multi-turn arrays для будущего использования.

    • Roles ограничены user, assistant или system в validator
    • Metadata в headers только когда documented — придерживайтесь JSON contract
    • Invalid shapes возвращают 400 с Zod detail strings для быстрого debug
    Открыть вкладку Deployment
  • Режим потоковой передачи

    Установите stream: true, чтобы получать NDJSON chunks (один JSON object per line), которые frontends flush в UI по мере arrival tokens.

    • Идеально для mobile или desktop clients с parity hosted widget
    • Errors mid-stream тоже serialize как JSON lines, чтобы parsers recover
    • Отключите streaming, когда proxies aggressively buffer responses
  • Ключи API носителя против файлов cookie сеанса

    Service accounts должны использовать FlexyAgents connection key, сгенерированный per agent. Interactive testers могут rely на authenticated dashboard sessions, но server-to-server всегда Bearer tokens.

    • Keys encrypt at rest рядом с другими automation credentials
    • Rotating key не меняет agent ID в вашем URL
    • Invalid или missing keys возвращают 401 до любого model spend
    Контекст billing моделей
  • Limits, которые вы увидите в production

    Redis-backed rate limits возвращают 429 при traffic spikes. Plan enforcement добавляет MESSAGE_LIMIT_REACHED для hosted/BYOK monthly caps и token ceilings для hosted inference.

    • Автоматизация и чат объединяют историю бухгалтерского учета на уровне организации.
    • Log correlation IDs из error payloads при обращении в support
    • Обновите или добавьте кредиты, если выставление счетов позволяет увеличить пропускную способность.
    Использование и планы

События

Приведите свой stack в FlexyAgents — и push events обратно

Inbound routes normalize vendor signatures, outbound configuration живёт рядом с другими integrations. Automations также могут POST arbitrary HTTP в flow.

  • Триггеры вебхука автоматизации

    Когда flow публикует webhook trigger, FlexyAgents хранит path segment и verifies payloads перед вызовом executeAutomation с parsed body.

    • Сочетайте с agent steps, вызывающими Slack, CRMs или custom REST endpoints
    • Feature gating может требовать upgraded plans перед generic ingress
    • Logs surface в той же automation run history, что OAuth triggers
    Обзор automations
  • Обратные вызовы провайдера канала

    WhatsApp, Instagram DMs, Messenger и inbound email регистрируют public HTTPS endpoints, чтобы Meta, Twilio или mail providers verify и deliver events.

    • Настройте callback URLs в vendor console под ваш deployment host
    • Verification handshakes на тех же routes, что live traffic
    • Compliance-sensitive payloads остаются на infrastructure, которую вы уже audit
    Развертывание каналов
  • Исходящие действия HTTP

    Automation actions могут POST или PUT на customer-owned URLs с templated bodies — «notify Opsgenie» или «create Jira ticket» без ожидания first-party connector.

    • Сопоставление полей триггеров в телах JSON с помощью конструктора автоматизации
    • Повторные попытки и обработка ошибок соответствуют настройкам по умолчанию исполнителя автоматизации.
    • Combine с agent steps для human-readable summaries перед delivery

Справка

Спецификации, документация и исследовательские инструменты

Marketing pages остаются narrative; engineers должны rely на docs site, inline OpenAPI definitions в repo и deployment page snippets, которые всегда match ваши tenant IDs.

  • Центр документации

    Начните с /docs для conceptual guides, затем cross-link на developer-focused /api для quick starts, authentication primers и tabbed references, где available.

    • В примерах особое внимание уделяется шаблонам встраивания Curl, JavaScript и виджетов.
    • SDK и Postman promises должны match downloads, которые мы реально ship
    • Сообщайте о пробелах через службу поддержки, чтобы согласовать работу маркетологов и технических писателей.
    Открыть docs
  • Источник истины OpenAPI

    Repository carries comprehensive OpenAPI document с auth schemes, chat payloads и ancillary REST resources — generate clients или import в Postman из этого файла.

    • Управление версиями соответствует периодичности выпуска пакетов, а не на этой целевой странице.
    • URL-адреса промежуточной и производственной базы перечислены в списке серверов спецификации.
    • Local developers hit тот же /api/agents/{id}/chat path на localhost, что production на tenant host
    Страница API разработчика
  • Виджет и мобильные спутники

    Не каждый experience нуждается в raw REST — embeddable script calls тот же chat endpoint с visitor context. Pair API access с widget, когда нужен web self-service плюс backend jobs.

    • Hosted pages reuse agent configuration, которую вы уже tested
    • CSP и cookie policies должны allow widget origin, который вы configure
    • Deep links из email могут open hosted chat с query parameters
    Веб-поверхности

Сочетайте API с Автоматизации, Каналы и управлением в Аналитика.

Следующий шаг

Скопируйте рабочий curl и подготовьте к продакшену

Сгенерируйте ключ подключения FlexyAgents, сохраните в хранилище секретов и направьте вебхуки автоматизации на контролируемые вами пути. Когда будете готовы, подключите наблюдаемость к тому же рабочему пространству аналитики, которое уже использует ваша команда успеха клиентов.