> ## Documentation Index
> Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml post /v0/applications/{id}/chatbot/chat
openapi: 3.1.1
info:
  title: Avido API
  description: >-
    Avido's API for LLM usage events, tool calls, trace management, webhook
    validation, and more. See each endpoint's request/response schema for
    details.
  version: 0.1.0
  contact:
    name: Avido Support
    email: support@avidoai.com
    url: https://avidoai.com/support
servers:
  - url: https://api.avidoai.com
    description: Production API
security:
  - ApiKey: []
    ApplicationId: []
paths:
  /v0/applications/{id}/chatbot/chat:
    post:
      tags:
        - Application Chatbot Config
      summary: Stream application chatbot playground response
      description: >-
        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.
      operationId: applicationChatbotChat
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
            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)$
            description: The unique identifier of the application
            example: 123e4567-e89b-12d3-a456-426614174000
          required: true
          description: The unique identifier of the application
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationChatbotChatRequest'
      responses:
        '200':
          description: Streaming UI message response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssistantChatStreamResponse'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/AssistantChatStreamResponse'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ApplicationChatbotChatRequest:
      type: object
      properties:
        messages:
          minItems: 1
          maxItems: 30
          type: array
          items: {}
          description: >-
            UI message history for the assistant. The server performs strict
            runtime validation of the message structure before model invocation.
        conversationId:
          description: Optional client-provided conversation identifier for observability.
          example: chat_4f1b2c9d
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[A-Za-z0-9_-]+$
        model:
          $ref: '#/components/schemas/ChatbotPlaygroundModel'
          description: >-
            Logical model class to answer with. Omit for the default model.
            `sota` transparently falls back to `default` on deployments without
            a SOTA model.
        reasoningEffort:
          $ref: '#/components/schemas/ChatbotPlaygroundReasoningEffort'
          description: >-
            Explicit reasoning-effort budget. Omit (the playground's 'Off'
            setting) to use the selected model's default reasoning behavior.
      required:
        - messages
      additionalProperties: false
      title: ApplicationChatbotChatRequest
      description: >-
        Request body for streaming a chatbot playground response, including the
        optional model and reasoning-effort selection.
    AssistantChatStreamResponse:
      type: string
      title: AssistantChatStreamResponse
      description: SSE stream payload emitted by the assistant endpoint.
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message explaining the error.
          example: Resource not found
      required:
        - message
      additionalProperties: false
      title: ErrorResponse
      description: Standard error format for failed API operations.
    ValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message indicating what went wrong.
          example: Invalid request data
        issues:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              path:
                type: array
                items:
                  type: string
            required:
              - code
              - message
              - path
            additionalProperties: false
          description: Array of detailed validation error objects.
          example:
            - code: invalid_string
              message: Invalid UUID
              path:
                - id
      required:
        - message
        - issues
      additionalProperties: false
      title: ValidationErrorResponse
      description: Details about validation errors in incoming requests.
    ChatbotPlaygroundModel:
      type: string
      enum:
        - default
        - mini
        - sota
      title: ChatbotPlaygroundModel
      description: >-
        Logical model class for a chatbot playground turn. `sota` targets the
        latest state-of-the-art model and transparently falls back to `default`
        on deployments without a SOTA model.
      example: sota
    ChatbotPlaygroundReasoningEffort:
      type: string
      enum:
        - low
        - medium
        - high
        - xhigh
      title: ChatbotPlaygroundReasoningEffort
      description: >-
        Explicit reasoning-effort budget for a chatbot playground turn. Omit the
        field entirely (the playground's 'Off' setting) to use the selected
        model's default reasoning behavior.
      example: medium
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your unique Avido API key
    ApplicationId:
      type: apiKey
      in: header
      name: x-application-id
      description: Your unique Avido Application ID

````