Overview
The Audio Overview API generates conversational audio summaries from your completed notebook research. The endpoint creates a podcast-style discussion that synthesizes the research findings into an engaging audio format.Generate Audio Overview
POST /research/audio-overview/{notebook_id}
Generate an audio overview from a notebook’s research summary
Request
The notebook ID containing completed research to generate audio from
Response
Unique identifier for the audio generation task
The notebook ID where results will be stored
Current task status:
IN_QUEUEHuman-readable status message
Example Request
Example Response
Error Responses
Check Task Status
Once submitted, use the Get Task Status endpoint to monitor progress:Example Completed Task Response
Audio Overview Structure
The generated audio overview contains a transcript with multiple speakers:Array of conversation segments
How It Works
- Research Summary: The agent analyzes the notebook’s research summary
- Script Generation: Creates a conversational podcast-style script with multiple speakers
- Transcript Output: Returns the structured transcript for audio synthesis
- Storage: Results are stored in the notebook for later retrieval
Best Practices
- Complete Research First: Ensure the notebook has completed research before generating audio
- Async Processing: Audio generation is async - use task status polling to monitor progress
- Error Handling: Implement retry logic for 500 errors
- Notebook Validation: Always check that the notebook exists before submitting the task
Use Cases
- Create podcast-style summaries of research topics
- Generate audio briefings for on-the-go consumption
- Produce engaging content from research findings
- Accessibility: Convert written research into audio format