ストリーミング対応

エージェントワークフロー向け UnifAPI のストリーミング対応

UnifAPI は、エージェントが進捗のフィードバックを必要とする場面でストリーミングをサポートします。ライブのツールセッション向けの Streamable HTTP MCP と、公開 ask エンドポイントの Server-Sent Events です。直接の REST API 呼び出しは、予測可能な単一レスポンスの JSON エンベロープを維持します。

/ask を開く

MCP Streamable HTTP

エージェントが進捗を把握できるツールの発見とツール呼び出しを必要とするときは、ホスト型の UnifAPI MCP サーバーを使います。コネクタ URL: https://mcp.unifapi.com。

MCP Streamable HTTP を開く

NLWeb ask SSE

start、result、complete イベントを発行する軽量なディスカバリ回答には、/ask の Server-Sent Events を使います。

NLWeb ask SSE を開く

直接 REST JSON

公開データの呼び出しごとに 1 つの正規化された JSON エンベロープを求めるプロダクトコードには、直接の HTTP API ルートを使います。

直接 REST JSON を開く

SSE クイックスタート

/ask からディスカバリ回答をストリーミング

Accept: text/event-stream を送信するか、prefer.streaming を設定すると、段階的なイベントを受信できます。このエンドポイントは UnifAPI のディスカバリ回答向けです。ライブの公開データツール呼び出しが必要なときは、エージェントを接続してください — プロンプトを 1 つ貼り付けるか、ライブデータ用の Web コネクタを追加します。

curl -N https://unifapi.com/ask \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{"query":{"text":"Where is the UnifAPI OpenAPI spec?"},"prefer":{"streaming":true}}'

イベントコントラクト

エージェントが想定すべきイベント

start

ストリームが開いたことを確認し、UnifAPI の NLWeb スタイルのメタデータを含みます。

result

タイトル、URL、スニペット、ソースメタデータを含む 1 件の回答結果を運びます。

complete

ストリームの終了を示し、エージェントが待機をやめて要約できるようにします。

直接 REST の挙動

https://api.unifapi.com での直接 REST API 操作は、現在 1 回の呼び出しにつき 1 つの正規化された JSON エンベロープを返します。長時間実行される REST ワークフローでは、エージェントはページネーション、リクエスト ID、リトライ、ドキュメント化されたエラーを利用してください。タスクがエージェント保持のセッションと段階的なツール処理から恩恵を受ける場合は MCP を使います。