Endpoints

Abonneren op stream

Abonneer u op een actieve chatstream voor realtime AI-antwoorden

GET/api/chat/{chatId}/subscribe

Abonneer u op een actieve chatstream om realtime AI-antwoorden te ontvangen. Dit is een alternatief voor het opvragen van het endpoint Status ophalen.

Verzoek

GET /api/chat/{chatId}/subscribe

Headers

HeaderVereistBeschrijving
AuthorizationJaBearer macaly_...

Padparameters

ParameterTypeBeschrijving
chatIdstringDe chat-ID die is geretourneerd door POST /api/chat

Voorbeeldverzoek

curl -N https://www.macaly.com/api/chat/abc123/subscribe \
  -H "Authorization: Bearer macaly_abc123..."

Respons

Retourneert een Server-Sent Events (SSE)-stream met workflowvoortgang en AI-antwoorden.

Streamformaat

De stream gebruikt het data stream-protocol van de Vercel AI SDK v4. Elke chunk heeft een typeprefix:

PrefixBeschrijving
0:Tekstinhoud
2:Data-objecten (zoals { chatId })
8:Annotaties en metadata

Voorbeeldstream

2:[{"chatId":"abc123"}]
0:"I'll create a landing page for you."
0:" Let me start by setting up the project structure."
8:{"type":"tool-call","toolName":"WriteFile",...}
0:" Done! Your landing page is ready."

Statuscodes

StatusBeschrijving
200Succes (streamingrespons)
204Geen actieve stream (workflow voltooid of nog niet gestart)
401Ongeldige of ontbrekende API-sleutel
403Chat behoort niet tot uw team
404Chat niet gevonden
429Limiet bereikt

Opmerkingen

  • De stream stopt wanneer de workflow is voltooid
  • Als u dit endpoint aanroept nadat de workflow is afgelopen, krijgt u een 204 No Content-respons
  • Voor eenvoudigere implementaties kunt u overwegen het endpoint Status ophalen te gebruiken