Suporte a streaming

Suporte a streaming da UnifAPI para fluxos de trabalho de agents

O UnifAPI oferece suporte a streaming onde os agents precisam de feedback de progresso: MCP Streamable HTTP para sessões de ferramentas ao vivo e Server-Sent Events no endpoint público de perguntas. As chamadas diretas à API REST mantêm o previsível envelope JSON de uma única resposta.

Abrir /ask

MCP Streamable HTTP

Use o servidor MCP hospedado da UnifAPI quando um agent precisa de descoberta e chamadas de ferramentas com reconhecimento de progresso. URL do conector: https://mcp.unifapi.com.

Abrir MCP Streamable HTTP

SSE de perguntas NLWeb

Use Server-Sent Events em /ask para respostas de descoberta leves que emitem os eventos start, result e complete.

Abrir SSE de perguntas NLWeb

JSON REST direto

Use rotas de API HTTP diretas para código de produto que precisa de um único envelope JSON normalizado por chamada de dados públicos.

Abrir JSON REST direto

Início rápido com SSE

Receba respostas de descoberta em streaming a partir de /ask

Envie Accept: text/event-stream ou defina prefer.streaming para receber eventos progressivos. Este endpoint serve para respostas de descoberta da UnifAPI; conecte seu agent — um prompt ou um conector web para dados ao vivo — quando um agent precisa de chamadas de ferramenta de dados públicos ao vivo.

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

Contrato de eventos

Eventos que os agents devem esperar

start

Confirma que o stream foi aberto e inclui metadados no estilo NLWeb da UnifAPI.

result

Carrega um resultado de resposta com título, URL, trecho e metadados de origem.

complete

Marca o fim do stream para que um agent possa parar de esperar e resumir.

Comportamento de REST direto

As operações diretas da API REST em https://api.unifapi.com atualmente retornam um único envelope JSON normalizado por chamada. Para fluxos de trabalho REST de longa duração, os agents devem usar paginação, IDs de requisição, retentativas e erros documentados. Use o MCP quando a tarefa se beneficia de uma sessão mantida pelo agent e de trabalho progressivo com ferramentas.