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

# POST /api/conversations/{conversationId}/stream

> ----------------------------------------------------------------------



## OpenAPI

````yaml /api/worksong.openapi.json post /api/conversations/{conversationId}/stream
openapi: 3.1.0
info:
  title: Worksong API
  version: 042e65d5f227
  description: >-
    The HTTP API behind the Worksong apps, generated from the code at the commit
    below. Request and response shapes come from the shared zod contract; an
    operation marked `x-gaps` has a part the generator could not resolve.
  x-source: worksong-ai/worksong@042e65d5f2275493f60f879c7970dcfdeceb7e0e
servers:
  - url: https://app.worksong.ai
security:
  - bearerAuth: []
tags:
  - name: Approvals
  - name: Audit
  - name: Avatar generator
  - name: Bootstrap
  - name: Bot compute limit
  - name: Bot mcp servers
  - name: Bots
  - name: Calls
  - name: Connections
  - name: Contacts
  - name: Conversations
  - name: Coupons
  - name: Day grants
  - name: Desktop
  - name: Entity files
  - name: Files
  - name: Github
  - name: Insights
  - name: Login
  - name: Mcp servers
  - name: Me
  - name: Me bot messaging
  - name: Me chat header
  - name: Me daily limit
  - name: Me time zone
  - name: Memory
  - name: Message delete
  - name: Messages
  - name: Notifications
  - name: Optimize prompt
  - name: Phone
  - name: Places
  - name: Projects
  - name: Public file links
  - name: Push
  - name: Queue
  - name: Reactions
  - name: Register
  - name: Rooms
  - name: Routes
  - name: Routines
  - name: Runs
  - name: Skills
  - name: Tasks
  - name: Transcribe
  - name: Tts
  - name: Webhooks
  - name: Whats new
  - name: Whatsapp
  - name: Workspace files
paths:
  /api/conversations/{conversationId}/stream:
    post:
      tags:
        - Messages
      summary: POST /api/conversations/{conversationId}/stream
      description: '----------------------------------------------------------------------'
      operationId: post_api_conversations_conversationId_stream
      parameters:
        - name: conversationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  minLength: 1
                  maxLength: 1000000
                idempotencyKey:
                  type: string
                  minLength: 8
                  maxLength: 200
                  pattern: ^[A-Za-z0-9._:-]+$
                model:
                  type: string
                  minLength: 1
                  maxLength: 128
                  pattern: ^[A-Za-z0-9._@:/-]+$
                maxTurns:
                  type: integer
                  minimum: 1
                  maximum: 1000
                maxBudgetUsd:
                  type: number
                  exclusiveMinimum: 0
                  maximum: 1000
                effort:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                    - xhigh
                    - max
                detach:
                  type: boolean
                fileIds:
                  maxItems: 8
                  type: array
                  items:
                    type: string
                    format: uuid
                location:
                  type: object
                  properties:
                    latitude:
                      type: number
                      minimum: -90
                      maximum: 90
                    longitude:
                      type: number
                      minimum: -180
                      maximum: 180
                    accuracyMeters:
                      type: number
                      minimum: 0
                      maximum: 1000000
                    precision:
                      type: string
                      enum:
                        - precise
                        - approximate
                    capturedAt:
                      type: string
                      format: date-time
                    placeName:
                      type: string
                      minLength: 1
                      maxLength: 200
                  required:
                    - latitude
                    - longitude
                    - accuracyMeters
                    - precision
                    - capturedAt
                  additionalProperties: false
                replyTo:
                  type: object
                  properties:
                    seq:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                  required:
                    - seq
                  additionalProperties: false
                quickReply:
                  type: object
                  properties:
                    seq:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    index:
                      type: integer
                      minimum: 0
                      maximum: 3
                    indices:
                      minItems: 1
                      maxItems: 4
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 3
                  required:
                    - seq
                    - index
              required:
                - text
                - idempotencyKey
              additionalProperties: false
      responses:
        '200':
          description: A server-sent event stream.
          content:
            text/event-stream:
              schema:
                type: string
        4XX:
          description: Error. A problem object with a status and a message.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.