diff --git a/fern/products/api-def/ferndef-pages/endpoints/sse.mdx b/fern/products/api-def/ferndef-pages/endpoints/sse.mdx index a57e49e56..a619c61c8 100644 --- a/fern/products/api-def/ferndef-pages/endpoints/sse.mdx +++ b/fern/products/api-def/ferndef-pages/endpoints/sse.mdx @@ -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. diff --git a/fern/products/api-def/openapi-pages/endpoints/sse.mdx b/fern/products/api-def/openapi-pages/endpoints/sse.mdx index 6787b3be0..24c885f85 100644 --- a/fern/products/api-def/openapi-pages/endpoints/sse.mdx +++ b/fern/products/api-def/openapi-pages/endpoints/sse.mdx @@ -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. diff --git a/fern/products/docs/pages/api-references/api-explorer.mdx b/fern/products/docs/pages/api-references/api-explorer.mdx index 019658fce..2a5b415f7 100644 --- a/fern/products/docs/pages/api-references/api-explorer.mdx +++ b/fern/products/docs/pages/api-references/api-explorer.mdx @@ -27,6 +27,12 @@ Allow users to test their calls in a sandbox environment or select the environme
+## 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.