Retrieve all information about a PlayNote.
cURL
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" }
Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.
Bearer YOUR_SECRET_API_KEY
Your unique user ID from PlayAI.
application/json
The PlayNote's ID
"qHMJf1MqlSPsfBdQIyYi"
PlayNote retrieved successfully
The response is of type object.
object
Was this page helpful?