POST
/
api
/
v1
/
playnotes
curl --request POST \
  --url https://api.play.ai/api/v1/playnotes \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>' \
  --header 'content-type: multipart/form-data' \
  --form 'sourceFileUrl=<string>' \
  --form synthesisStyle=podcast \
  --form voice1=s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json \
  --form voice1Name=Angelo \
  --form voice1Gender=Male \
  --form voice2=s3://voice-cloning-zero-shot/e040bd1b-f190-4bdb-83f0-75ef85b18f84/original/manifest.json \
  --form voice2Name=Deedee \
  --form voice2Gender=Female \
  --form webHookUrl=https://my.webhook.url.com
{
  "id": "qHMJf1MqlSPsfBdQIyYi",
  "ownerId": "gpTwobxZzJRczfqommFemErGJTU2",
  "name": "<string>",
  "sourceFileUrl": "<string>",
  "audioUrl": "<string>",
  "synthesisStyle": "podcast",
  "voice1": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voice1Name": "<string>",
  "voice1Gender": "<string>",
  "voice2": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voice2Name": "<string>",
  "voice2Gender": "<string>",
  "webHookUrl": "https://my.webhook.url.com",
  "status": "generating",
  "duration": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

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
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

​
X-USER-ID
string
header
required

Your unique user ID from PlayAI.

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.

Example:

"s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json"

​
voice1Name
string | null
required

Name of the voice1 character in the PlayNote

Example:

"Angelo"

​
voice1Gender
string | null

Gender of the voice1 character in the PlayNote

Example:

"Male"

​
voice2
string

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

Example:

"s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json"

​
voice2Name
string | null

Name of the voice2 character in the PlayNote

Example:

"Deedee"

​
voice2Gender
string | null

Gender of the voice2 character in the PlayNote

Example:

"Female"

​
webHookUrl
string

A URL to receive status and progress updates on the generation of the PlayNote.

Example:

"https://my.webhook.url.com"

Response

201 - application/json
PlayNote created successfully
​
id
string
required

The unique ID for each PlayNote

Example:

"qHMJf1MqlSPsfBdQIyYi"

​
ownerId
string
required

The PlayAI unique ID for each user

Example:

"gpTwobxZzJRczfqommFemErGJTU2"

​
name
string
required

The name of the PlayNote

​
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 unique ID for a PlayAI Voice.

Example:

"s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json"

​
status
enum<string>
required

The current status of the PlayNote

Available options:
generating,
completed,
failed
​
requestedAt
string
required

When the PlayNote was requested

​
audioUrl
string | null

URL to the generated PlayNote audio file

​
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.

Example:

"s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json"

​
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.

Example:

"https://my.webhook.url.com"

​
duration
number | null

Duration of the audio in seconds

​
createdAt
string | null

When the PlayNote was created

Was this page helpful?