Skip to main content
POST
Stream application chatbot playground response

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

id
string<uuid>
required

The unique identifier of the application

Pattern: ^([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)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for streaming a chatbot playground response, including the optional model and reasoning-effort selection.

messages
any[]
required

UI message history for the assistant. The server performs strict runtime validation of the message structure before model invocation.

Required array length: 1 - 30 elements
conversationId
string

Optional client-provided conversation identifier for observability.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"chat_4f1b2c9d"

model
enum<string>

Logical model class to answer with. Omit for the default model. sota transparently falls back to default on deployments without a SOTA model.

Available options:
default,
mini,
sota
Example:

"sota"

reasoningEffort
enum<string>

Explicit reasoning-effort budget. Omit (the playground's 'Off' setting) to use the selected model's default reasoning behavior.

Available options:
low,
medium,
high,
xhigh
Example:

"medium"

Response

Streaming UI message response

SSE stream payload emitted by the assistant endpoint.