流式支持

面向 Agent 工作流的 UnifAPI 流式支持

UnifAPI 在 Agents 需要进度反馈的场景下支持流式传输：用于实时工具会话的 Streamable HTTP MCP，以及公开 ask 端点上的 Server-Sent Events。直连 REST API 调用则保持可预期的单次响应 JSON 封装。

打开 /ask

MCP Streamable HTTP

当 Agent 需要具备进度感知的工具发现与工具调用时，使用托管的 UnifAPI MCP 服务器。连接器 URL：https://mcp.unifapi.com。

打开 MCP Streamable HTTP

NLWeb ask SSE

在 /ask 上使用 Server-Sent Events，以获取会发出 start、result 与 complete 事件的轻量级发现答案。

打开 NLWeb ask SSE

Direct REST JSON

当产品代码希望每次公开数据调用都返回一个规范化的 JSON 封装时，使用直连 HTTP API 路由。

打开 Direct REST JSON

SSE 快速上手

从 /ask 流式获取发现答案

发送 Accept: text/event-stream 或设置 prefer.streaming，即可接收渐进式事件。该端点用于 UnifAPI 的发现答案；连接你的 Agent——一段提示词，或为实时数据添加一个 web 连接器——当 Agent 需要实时公开数据工具调用时使用。

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}}'

事件契约

Agents 应当预期的事件

start

确认流已开启，并包含 UnifAPI NLWeb 风格的元数据。

result

携带一条答案结果，包含标题、URL、摘要与来源元数据。

complete

标记流的结束，让 Agent 可以停止等待并进行总结。

直连 REST 的行为

位于 https://api.unifapi.com 的直连 REST API 操作目前每次调用返回一个规范化的 JSON 封装。对于长时间运行的 REST 工作流，Agents 应使用分页、请求 id、重试以及已文档化的错误。当任务能从 Agent 持有的会话与渐进式工具工作中获益时，请使用 MCP。