Skip to main content
GET
/
v1
/
voice
/
design
/
{id}
Get design candidates
curl --request GET \
  --url https://api.pyai.com/v1/voice/design/{id} \
  --header 'Authorization: Bearer <token>'
{
  "design_id": "dsn_a1b2c3",
  "candidates": [
    {
      "candidate_id": "c1",
      "preview_url": "<string>",
      "quality": {
        "intelligibility": 1
      },
      "duration_s": 3.4
    }
  ]
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

id
string
required

Design id.

Response

Design status + candidates

design_id
string
Example:

"dsn_a1b2c3"

status
enum<string>
Available options:
queued,
running,
completed,
failed
candidates
object[]