GET
/
api
/
v1
/
playnotes
/
{playNoteId}
curl --request GET \
  --url https://api.play.ai/api/v1/playnotes/{playNoteId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>'
{
  "id": "qHMJf1MqlSPsfBdQIyYi",
  "ownerId": "gpTwobxZzJRczfqommFemErGJTU2",
  "name": "<string>",
  "sourceFileUrl": "<string>",
  "audioUrl": "<string>",
  "synthesisStyle": "podcast",
  "voice1": "s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json",
  "voice1Name": "<string>",
  "voice1Gender": "Male",
  "voice2": "s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json",
  "voice2Name": "<string>",
  "voice2Gender": "Male",
  "webHookUrl": "https://my.webhook.url.com",
  "status": "generating",
  "duration": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

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

​
accept
enum<string>
Available options:
application/json

Path Parameters

​
playNoteId
string
required

The PlayNote's ID

Example:

"qHMJf1MqlSPsfBdQIyYi"

Response

200 - application/json
PlayNote retrieved successfully

The response is of type object.