---
title: "TinyMCE AI Streaming"
description: "Streaming configuration for TinyMCE AI"
canonical_url: "https://www.tiny.cloud/docs/tinymce/latest/tinymceai-streaming/"
md_url: "https://www.tiny.cloud/docs/tinymce/latest/tinymceai-streaming/index.md"
version: "latest"
last_updated: "2026-09-28T00:27:52Z"
tokens: 1021
---
# TinyMCE AI Streaming

Real-time AI interactions using Server-Sent Events (SSE) for immediate feedback and progressive content generation.

## Overview

TinyMCE AI services use Server-Sent Events (SSE) to provide real-time streaming responses. This allows users to see AI-generated content as it is being created, providing immediate feedback and enabling interactive experiences.

## SSE Event Types

Conversations, Reviews, and Actions each use different event names and JSON payloads in the SSE stream. Those payloads are documented on each streaming operation in the [interactive API documentation](https://tinymceai.api.tiny.cloud/docs), not on the feature overview pages (which only summarize that SSE is used).

Use the API reference for the operation being called—for example:

- [Conversation Messages](https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages) and related Conversation tags for chat streaming, sources, and reasoning.
- [Reviews API](https://tinymceai.api.tiny.cloud/docs#tag/Reviews) for review streaming responses.
- [Actions API](https://tinymceai.api.tiny.cloud/docs#tag/Actions) for action streaming responses.

The shared wire format and client-side parsing are covered in [SSE wire format](#sse-wire-format) and [Basic implementation](#basic-implementation) on this page.

## SSE wire format

The response body is a text stream in [Server-Sent Events](https://html.spec.whatwg.org/multipage/server-sent-events.html) format. Events are separated by blank lines. Each event can include an `event:` line (event name) and one or more `data:` lines (payload; long payloads may be split across several `data:` lines). For example:

```
event: <event-name-1>
data: <data>

event: <event-name-2>
data: <data2>
```
Parsing this format correctly (including chunk boundaries, multi-line `data:` fields, and comments) is easy to get wrong in hand-written loops. For production code, use a maintained SSE parser such as the [`eventsource-parser`](https://www.npmjs.com/package/eventsource-parser) package.

## Basic Implementation

After obtaining a streaming `Response` from `fetch`, pass the byte stream through an SSE parser. The following example uses [`eventsource-parser`](https://www.npmjs.com/package/eventsource-parser) to turn raw chunks into parsed events; application code then inspects each event payload (for example JSON with an `event` field and `data` for TinyMCE AI services):

```javascript
import { createParser } from 'eventsource-parser';

const response = await fetch('/v1/your-endpoint', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    // Request payload
  })
});

const parser = createParser({
  onEvent: (event) => {
    // event.event is the SSE event name (if present)
    // event.data is the reassembled data string for this event
    const data = JSON.parse(event.data);

    switch (data.event) {
      case 'error':
        console.error('Error:', data.data.message);
        break;
      default:
        // Handle all other events — event names vary by API; see
        // https://tinymceai.api.tiny.cloud/docs for each operation's schema.
        // Examples: Conversations (text-delta, source, reasoning, modification-delta),
        // Reviews (review-delta, review-metadata), Actions (modification-delta, action-metadata)
        console.log('Event:', data.event, data.data);
    }
  }
});

const reader = response.body.getReader();
const decoder = new TextDecoder();

while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  parser.feed(decoder.decode(value, { stream: true }));
}
```

## Error Handling

Always handle errors gracefully:

```javascript
if (data.event === 'error') {
  const error = data.data;
  console.error('Streaming error:', error.message);
}
```

## Progress Tracking

Use metadata events to show progress. Event names and fields for review streaming are defined in the [Reviews API](https://tinymceai.api.tiny.cloud/docs#tag/Reviews) operations that return SSE responses, not in the Review plugin overview.

## API Reference

The [interactive API documentation](https://tinymceai.api.tiny.cloud/docs) describes streaming endpoints, event shapes, and errors for each feature area.

## Next Steps

- [Chat](../tinymceai-chat/), [Review](../tinymceai-review/), and [Quick Actions](../tinymceai-actions/) for product behavior and editor integration.
- [AI Models](../tinymceai-models/) for model configuration and limits.