Skip to content

docs: add SSE streaming endpoints section to API Explorer documentation #2905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 6 commits into
base: main
Choose a base branch
from
+14 −0
Open

docs: add SSE streaming endpoints section to API Explorer documentation #2905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
574defa
docs: add SSE streaming endpoints section to API Explorer documentation
devin-ai-integration[bot] Dec 20, 2025
569e900
docs: add direct link to Hume SSE example
devin-ai-integration[bot] Dec 20, 2025
f1174be
docs: add links from API definition SSE pages to API Explorer
devin-ai-integration[bot] Dec 20, 2025
b2fbece
small edits for clarity
devalog Dec 20, 2025
7bc1aab
update heading
devalog Dec 20, 2025
372de31
edit
devalog Dec 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/api-def/ferndef-pages/endpoints/sse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,7 @@ types:
properties:
text: string
```

## API Explorer

The [API Explorer](/learn/docs/api-references/api-explorer/overview#streaming-endpoints) supports streaming endpoints, displaying responses in real-time.
4 changes: 4 additions & 0 deletions fern/products/api-def/openapi-pages/endpoints/sse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,7 @@ components:
text:
type: string
```

## API Explorer

The [API Explorer](/learn/docs/api-references/api-explorer/overview#streaming-endpoints) supports streaming endpoints, displaying responses in real-time.
6 changes: 6 additions & 0 deletions fern/products/docs/pages/api-references/api-explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ Allow users to test their calls in a sandbox environment or select the environme

<div style="position: relative; padding-bottom: 50.63657407407407%; height: 0;"><iframe src="https://www.loom.com/embed/cb642161678e41cabcb677b900006f40?sid=5e45243c-3ba1-45cf-860b-72eee1970fc5?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

## Streaming endpoints

The API Explorer supports streaming endpoints, including Server-Sent Events (SSE). When an endpoint is configured as streaming in your API specification, the API Explorer streams the response in real-time as data arrives ([example](https://dev.hume.ai/reference/text-to-speech-tts/synthesize-json-streaming?explorer=true)).

To configure a streaming endpoint, use the [`x-fern-streaming`](/learn/api-definitions/openapi/endpoints/sse) extension in your OpenAPI specification or the [`response-stream`](/learn/api-definitions/ferndef/endpoints/sse) key in your Fern Definition.

## WebSocket Playground

For APIs that support WebSocket connections, the API Explorer includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time.
Expand Down
Loading