Stream application chatbot playground response
Streams a chatbot playground response for a chatbot application with PostHog chatbot playground rollout enabled, using the application’s configured prompt and active knowledge base.
Authorizations
Your unique Avido API key
Your unique Avido Application ID
Path Parameters
The unique identifier of the application
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"123e4567-e89b-12d3-a456-426614174000"
Body
Request body for streaming a chatbot playground response, including the optional model and reasoning-effort selection.
UI message history for the assistant. The server performs strict runtime validation of the message structure before model invocation.
1 - 30 elementsOptional client-provided conversation identifier for observability.
1 - 128^[A-Za-z0-9_-]+$"chat_4f1b2c9d"
Logical model class to answer with. Omit for the default model. sota transparently falls back to default on deployments without a SOTA model.
default, mini, sota "sota"
Explicit reasoning-effort budget. Omit (the playground's 'Off' setting) to use the selected model's default reasoning behavior.
low, medium, high, xhigh "medium"
Response
Streaming UI message response
SSE stream payload emitted by the assistant endpoint.