From 859348c2fcb8624a3e936d66a6ac3c1266e372d3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 21:22:31 +0000 Subject: [PATCH 1/2] Update api-playground/multiple-responses.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- api-playground/multiple-responses.mdx | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/api-playground/multiple-responses.mdx b/api-playground/multiple-responses.mdx index e3a8776b7..a7b4589cd 100644 --- a/api-playground/multiple-responses.mdx +++ b/api-playground/multiple-responses.mdx @@ -30,3 +30,29 @@ responses: currencyCode: "GBP" taxRate: 0.20 ``` + +## Audio response examples + +For endpoints that return audio files, you can provide a URL to an audio file in the `examples` property. The API playground will render an interactive audio player instead of a code snippet. + +To configure audio response examples: + +1. Set the content type to an `audio/*` media type (e.g., `audio/mpeg`, `audio/wav`, `audio/ogg`) +2. Provide a valid URL to an audio file as the example value + +```yaml +responses: + "200": + description: Audio file generated successfully + content: + audio/mpeg: + schema: + type: string + format: binary + examples: + sample: + summary: Sample audio output + value: "https://example.com/sample-audio.mp3" +``` + +The audio URL will be embedded in an HTML audio player, allowing users to play the example directly in the documentation. From 814c147aad2ed60dcbe659b46cd35d0af5e81a0b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 6 Mar 2026 10:12:45 -0800 Subject: [PATCH 2/2] copyedit --- api-playground/multiple-responses.mdx | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/api-playground/multiple-responses.mdx b/api-playground/multiple-responses.mdx index a7b4589cd..1028a5e48 100644 --- a/api-playground/multiple-responses.mdx +++ b/api-playground/multiple-responses.mdx @@ -31,14 +31,11 @@ responses: taxRate: 0.20 ``` -## Audio response examples - -For endpoints that return audio files, you can provide a URL to an audio file in the `examples` property. The API playground will render an interactive audio player instead of a code snippet. +The playground also handles non-JSON response types differently based on their content type. -To configure audio response examples: +## Audio response examples -1. Set the content type to an `audio/*` media type (e.g., `audio/mpeg`, `audio/wav`, `audio/ogg`) -2. Provide a valid URL to an audio file as the example value +For endpoints that return audio files, set the response content type to `audio/*` and provide a URL to an audio file as the example value. The playground renders an interactive audio player instead of a code snippet. ```yaml responses: @@ -54,5 +51,3 @@ responses: summary: Sample audio output value: "https://example.com/sample-audio.mp3" ``` - -The audio URL will be embedded in an HTML audio player, allowing users to play the example directly in the documentation.