Get All PlayNotes for User

Retrieve all PlayNotes owned by the authenticated user.

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

enum<string>

Available options:

application/json

Response

200 - application/json

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

webHookUrl

string

A URL to receive status and progress updates on the generation of 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