Skip to main content
Narration requires a Pro or Enterprise plan.
Narration adds a Listen to this page player at the top of each page. When a reader presses play, Mintlify generates a spoken version of the page and streams the audio into the browser. Mintlify generates narration on demand from your published content, so audio always matches the content of the page. When a page changes, the next listener triggers a fresh generation. The Listen to this page player only appears on pages with narratable content. Very short pages and pages that are mostly non-prose cannot be narrated. Narration is not available for deployments that require authentication to access. Narration uses credits from your organization’s shared credit balance. Each generation costs 50 credits. Replays of the same page version are free. See Credit pricing for details. Track usage on the Usage page of your dashboard.

​
How narration works

Narration reads the page title, description, and body in order. Mintlify announces steps, tabs, callouts, and accordions with short spoken cues. Narration skips code blocks, tables, media, and API fields. While audio plays, Mintlify highlights the sentence being read and scrolls to keep it in view. If a reader scrolls away, automatic scrolling stops and the audio continues. Readers can pause playback, track progress, and change playback speed from 0.8x to 2x. Opening another page stops the current narration.

​
Enable narration

  1. Navigate to the Narration section of the General settings in your dashboard.
  2. Enable Page narration.