Create PlayNote via File URL
Create a new PlayNote with either a source file URL or an uploaded file (but not both)
Check out the Generate Conversation from PDF with PlayNote API guide for a step-by-step approach to using the PlayNote API to create a podcast-style conversation (and more!) from a PDF.
Use this endpoint to create new PlayNotes. You can either provide a file URL or upload a file directly.
The endpoint presented in this page is used to create a new PlayNote by providing a file URL. If you want to upload a file directly, please refer to the Create PlayNote via File Upload endpoint.
After you create your PlayNotes, you can proceed to poll its status at our Get PlayNote API.
Note: You can have only one active generation. If you face this error code 403 with the message {"errorMessage":"User already has an active generation","errorId":"UNAUTHORIZED"} then please wait for some time and try again later.
Authorizations
API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.
User ID required for this endpoint. Get it from https://play.ai/developers.
Headers
multipart/form-data application/json Body
URL to the source file
The synthesis style of the PlayNote
podcast, executive-briefing, childrens-story, debate The ID for a PlayAI Voice to be used as first character in the PlayNote.
Name of the voice1 character in the PlayNote
Gender of the voice1 character in the PlayNote
The ID for a PlayAI Voice to be used as second character in the PlayNote, if applicable.
Name of the voice2 character in the PlayNote
Gender of the voice2 character in the PlayNote
A URL to receive status and progress updates on the generation of the PlayNote.
Response
The unique ID for each PlayNote
The PlayAI unique ID for each user
The name of the PlayNote
URL to the source file
The synthesis style of the PlayNote
podcast, executive-briefing, childrens-story, debate The unique ID for a PlayAI Voice.
The current status of the PlayNote
generating, completed, failed When the PlayNote was requested
URL to the generated PlayNote audio file
Name of the voice1 character in the PlayNote
Gender of the voice1 character in the PlayNote
The unique ID for a PlayAI Voice.
Name of the voice2 character in the PlayNote
Gender of the voice2 character in the PlayNote
A URL to receive status and progress updates on the generation of the PlayNote.
Duration of the audio in seconds
When the PlayNote was created