POST
/
api
/
v1
/
playnotes

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

AUTHORIZATION
string
headerrequired

API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.

X-USER-ID
string
headerrequired

User ID required for this endpoint. Get it from https://play.ai/developers.

Headers

content-type
enum<string>
required
Available options:
multipart/form-data
accept
enum<string>
Available options:
application/json

Body

multipart/form-data
sourceFileUrl
string
required

URL to the source file

synthesisStyle
enum<string>
required

The synthesis style of the PlayNote

Available options:
podcast,
executive-briefing,
childrens-story,
debate
voice1
string
required

The ID for a PlayAI Voice to be used as first character in the PlayNote.

voice1Name
string | null
required

Name of the voice1 character in the PlayNote

voice1Gender
string | null

Gender of the voice1 character in the PlayNote

voice2
string

The ID for a PlayAI Voice to be used as second character in the PlayNote, if applicable.

voice2Name
string | null

Name of the voice2 character in the PlayNote

voice2Gender
string | null

Gender of the voice2 character in the PlayNote

Response

201 - application/json
id
string
required

The unique ID for each PlayNote

ownerId
string
required

The PlayAI unique ID for each user

name
string
required

The name of the PlayNote

sourceFileUrl
string
required

URL to the source file

audioUrl
string | null

URL to the generated PlayNote audio file

synthesisStyle
enum<string>
required

The synthesis style of the PlayNote

Available options:
podcast,
executive-briefing,
childrens-story,
debate
voice1
string
required

The unique ID for a PlayAI Voice.

voice1Name
string

Name of the voice1 character in the PlayNote

voice1Gender
string

Gender of the voice1 character in the PlayNote

voice2
string

The unique ID for a PlayAI Voice.

voice2Name
string | null

Name of the voice2 character in the PlayNote

voice2Gender
string | null

Gender of the voice2 character in the PlayNote

status
enum<string>
required

The current status of the PlayNote

Available options:
generating,
completed,
failed
duration
number | null

Duration of the audio in seconds

requestedAt
string
required

When the PlayNote was requested

createdAt
string | null

When the PlayNote was created

Create PlayNote via File Upload