Skip to main content
POST
/
v0
/
applications
/
{id}
/
chatbot
/
chat
Stream application chatbot playground response
curl --request POST \
  --url https://api.avidoai.com/v0/applications/{id}/chatbot/chat \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "messages": [
    "<unknown>"
  ],
  "conversationId": "chat_4f1b2c9d"
}
'
"<string>"

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 an assistant response.

​
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"

Response

Streaming UI message response

SSE stream payload emitted by the assistant endpoint.