プラットフォーム · APIとWebhook

スライドではなく HTTPSで統合

サーバー間チャットを実装し、トークンを自社UIへストリーミングし、FlexyAgentsホスト上で終端するWebhookからオートメーションを起動できます。以下のルートは実際のNext.jsハンドラーです。FlexyAgents API接続を生成した後、デプロイ画面から値をコピーしてください。

  • POST /api/agents/{agentId}/chat は FlexyAgents 自動化接続に紐づく Bearer を受け付け、ウィジェットと同じ RAG + モデルスタックを実行します
  • オプションのストリーミングは NDJSON フラグメントを返します。ストリーミングなしの場合、応答は単一のアシスタントペイロードです
  • レート制限はプラン前に IP 単位で適用。ホスト型プランはトークン予算を適用し、BYOK はプロバイダーキー欠如時に明示的エラーを返します
  • Webhook トリガー、チャネルコールバック、アウトバウンド連携は同じテナンシーモデルを共有 — すべて organization_id と agent に解決されます
ドキュメントを読む開発者ハブ

先にキーが必要ですか？ ワークスペースを作成 し、 設定 → APIキー またはエージェントの接続モーダルを開いてください。

HTTPエンドポイント一覧

パスはNext.jsのルートツリーを反映しています。プレースホルダーをデプロイ画面のエージェントIDとホストに置き換えてください。

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

    エージェントチャット & ストリーミング

    messages 配列（role + content）と任意の stream フラグを含む JSON ボディを送信します。Bearer はエージェント接続に保存された FlexyAgents API キーに対して検証され、正しいキーの場合 organization_id が自動解決されます。

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

    自動化トリガー Ingress

    公開された自動化は Webhook URL を提供し、ペイロードをデシリアライズして executeAutomation を呼び出します — OAuth なしでフローを起動する必要があるサービスに有用です。

  • GET/POST/api/webhooks/*

    チャネル & プロバイダー Webhook

    /api/webhooks 配下の関連ルートが WhatsApp、Instagram、Facebook Messenger、受信メールなどのコールバックを処理し、オムニチャネルデプロイをお客様のドメイン上に保持します。

  • —Integrations → Webhooks

    アウトバウンド配信

    FlexyAgents が会話またはシステムイベントを SIEM、Data Lake、Ticketing Bridge にプッシュする場合、ダッシュボードで署名付きアウトバウンド Webhook を設定します。

最小限の非ストリーミング呼び出し

# YOUR_APP_HOST: 本番アプリのホスト名に置き換えてください
# YOUR_FLEXYAGENTS_API_KEY: エージェント接続に紐づく FlexyAgents API キー
curl -X POST "https://YOUR_APP_HOST/api/agents/AGENT_ID/chat" \
  -H "Authorization: Bearer YOUR_FLEXYAGENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"こんにちは"}],"stream":false}'

そのエージェントでFlexyAgentsアプリを接続した後、 デプロイ → API からコピーした値に置き換えてください。

呼び出し

ウィジェットと同じ頭脳による HTTPS ファーストチャット

デプロイ画面はライブホストに対する curl をコピーします。ハンドラーは自動化接続ストアに対して API キーを検証し、動作 + ナレッジを読み込み、他のチャネルと同様に利用量をインクリメントします。

  • messages 配列契約

    ボディには少なくとも 1 ラウンドのチャットが必要です。Executor は Retrieval 用に履歴を最後のユーザーメッセージにトリムしますが、将来の利用に向けてマルチターン配列も受け付けます。

    • ロールはバリデーターで user、assistant、system に限定
    • メタデータはドキュメント化されている場合のみヘッダー — JSON 契約を優先
    • 無効な形式は Zod 詳細付き 400 を返し、デバッグを高速化
    デプロイタブを開く

  • ストリーミングモード

    stream: true の場合、フロントエンドがトークン単位でレンダリングできる NDJSON フラグメント（1 行 1 JSON オブジェクト）を受け取ります。

    • ホスト型ウィジェットと同等のモバイル・デスクトップクライアントに最適
    • ストリーム途中のエラーも JSON 行としてシリアライズ
    • プロキシが応答を積極的にバッファする場合はストリーミングを無効化

  • Bearer API キー vs. セッション Cookie

    サービスアカウントはエージェントごとに生成された FlexyAgents 接続キーを使用する必要があります。対話的テストはダッシュボードセッションを利用可能ですが、サーバー間通信は常に Bearer です。

    • キーは他の自動化認証情報と同様に保存時暗号化
    • キーローテーションは URL 内の Agent ID を変更しません
    • 無効または欠如したキーはモデル出力前に 401 を返します
    モデル課金コンテキスト

  • 本番で確認できる制限

    Redis 制限はスパイク時に 429 を返します。プランは月次ホスト型/BYOK 上限の MESSAGE_LIMIT_REACHED と、ホスト型推論のトークン上限を追加します。

    • 自動化とチャットは同じ組織レベル課金を共有
    • サポートに連絡する際はエラーから相関 ID をログに記録
    • 請求でより高いスループットが許可される場合はプランアップグレードまたはクレジット追加
    利用量 & プラン

イベント

スタックを FlexyAgents に — イベントをプッシュバック

インバウンドルートはプロバイダー署名を正規化し、アウトバウンド設定は他の連携と並存します。自動化はフロー内で任意の HTTP POST も実行できます。

  • 自動化 Webhook トリガー

    フローが Webhook トリガーを公開すると、FlexyAgents はルートセグメントを保存し、parse されたボディで executeAutomation を呼び出す前にペイロードを検証します。

    • Slack、CRM、カスタム REST を呼び出すエージェントステップと組み合わせ可能
    • プラン制限により、汎用 Ingress の前に上位プランが必要な場合があります
    • ログは OAuth トリガーと同じ実行履歴に表示
    自動化概要

  • チャネルプロバイダーコールバック

    WhatsApp、Instagram DM、Messenger、受信メールは公開 HTTPS エンドポイントを登録し、Meta、Twilio、Mail が検証とイベントを配信できるようにします。

    • プロバイダーコンソールのコールバック URL をデプロイホストに合わせる
    • 検証ハンドシェイクはライブトラフィックと同じルート上
    • 機密ペイロードは既に監査しているインフラ上に保持
    チャネルデプロイ

  • アウトバウンド HTTP アクション

    自動化アクションはテンプレート化されたボディで顧客 URL に POST または PUT — 例：「Opsgenie に通知」や「Jira チケット作成」をファーストパーティ Connector なしで実行。

    • 自動化ビルダーでトリガーフィールドを JSON ボディにマッピング
    • リトライとエラーは自動化 Executor のデフォルトに従う
    • 配信前に読みやすい要約を生成するエージェントステップと組み合わせ

リファレンス

仕様、ドキュメント、探索ツール

マーケティングページはナラティブです。エンジニアは /docs、リポジトリ内の OpenAPI 定義、常にテナント ID に一致するデプロイスニペットを参照してください。

  • ドキュメントハブ

    /docs からコンセプトガイドを開始し、利用可能な場合は /api へ Quickstart、Auth 入門、タブリファレンスへのリンクを配置します。

    • curl、JavaScript、ウィジェット埋め込みパターン
    • SDK/Postman の約束は実際に提供する内容と一致する必要があります
    • ギャップはサポート経由で報告し、マーケティングと Tech Writing を整合
    ドキュメントを開く

  • OpenAPI を Source of Truth として

    リポジトリには Auth スキーマ、チャットペイロード、補助 REST リソースを含む完全な OpenAPI があります — クライアント生成または Postman へのインポートにご利用ください。

    • バージョニングはこのランディングページではなくパッケージリリースサイクルに従う
    • Staging と Production の Base URL は Spec の servers に記載
    • ローカルでは Prod と同じ Path /api/agents/{id}/chat をテナントホストで呼び出し
    Developer API ページ

  • ウィジェット & モバイルコンパニオン

    すべての体験に生 REST は不要 — 埋め込みスクリプトは訪問者コンテキスト付きで同じチャットエンドポイントを呼び出します。Web セルフサービスとバックエンドジョブの両方に API とウィジェットを組み合わせてください。

    • ホスト型ページは既にテスト済みのエージェント設定を再利用
    • CSP と Cookie は設定したウィジェット Origin を許可する必要があります
    • メールからの Deep Link で Query Params 付きホスト型チャットを開ける
    Web サーフェス

APIはオートメーション、チャネル、分析のガバナンスと組み合わせてご利用ください。

次のステップ

動作するcurlをコピーし、本番向けに強化

FlexyAgents接続キーを生成し、シークレットストアに保存し、所有するパスへオートメーションWebhookを向けてください。準備が整ったら、カスタマーサクセスチームが既に使っている分析ワークスペースにオブザーバビリティを接続できます。

無料で試すデモを予約