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

# Stream an agent reply word by word (SSE)

> Send a chat message and receive the agent reply as a Server-Sent Events stream. The endpoint runs the blocking chat path, then emits the answer word by word as `text/event-stream`: `token` events carry incremental text, a terminal `done` event carries totalTokens, costCents, and conversationId, and an `error` event carries a code and message. Use this for a typing-indicator experience when the SDK expects a streaming method. Rate limited to 20 requests per minute per tenant.



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/{id}/stream
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/agents/{id}/stream:
    post:
      tags:
        - Agents
      summary: Stream an agent reply word by word (SSE)
      description: >-
        Send a chat message and receive the agent reply as a Server-Sent Events
        stream. The endpoint runs the blocking chat path, then emits the answer
        word by word as `text/event-stream`: `token` events carry incremental
        text, a terminal `done` event carries totalTokens, costCents, and
        conversationId, and an `error` event carries a code and message. Use
        this for a typing-indicator experience when the SDK expects a streaming
        method. Rate limited to 20 requests per minute per tenant.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Identifier of the agent to converse with.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - message
              properties:
                message:
                  type: string
                  minLength: 1
                  description: User message to send to the agent.
                conversationId:
                  type: string
                  description: >-
                    Existing conversation id to append onto; omit to start a new
                    conversation.
                history:
                  type: array
                  description: >-
                    Optional prior turns to seed the agent, additive on top of
                    any persisted state.
                  items:
                    type: object
                    properties:
                      role:
                        type: string
                        description: user | assistant | system
                      content:
                        type: string
            example:
              message: What were my charges last month?
              conversationId: conv_9f2c1a
      responses:
        '200':
          description: >-
            Server-Sent Events stream of the agent reply. Emits `token` events
            with incremental text, a terminal `done` event, and an `error` event
            on failure.
          content:
            text/event-stream:
              schema:
                type: string
              example: >
                event: token

                data: {"text":"Your"}


                event: token

                data: {"text":"charges"}


                event: done

                data:
                {"totalTokens":128,"costCents":2,"conversationId":"conv_9f2c1a"}
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````