Text To Speech (Speak)

Get design candidates

Poll a design job. When status is completed, candidates carries signed preview URLs (24h TTL). Candidates below the quality gate are omitted. Requires the speak:design scope.

get/v1/voice/design/{id}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/voice/design/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Design id.

Response

Design status + candidates

design_idstring
status'queued' | 'running' | 'completed' | 'failed'

Example response

{
  "design_id": "dsn_a1b2c3",
  "candidates": [
    {
      "candidate_id": "c1",
      "quality": {
        "intelligibility": 1
      },
      "duration_s": 3.4
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.