Text To Speech (Speak)

Preview a designed-voice candidate

Fetch a short-lived audio preview for a candidate owned by the authenticated organization. Cross-organization and malformed lookups return the same not-found response. Requires the speak:design scope.

get/v1/voice/design/{id}/preview/{candidate_id}

Request

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

Path parameters

idstring required

Design job id.

candidate_idstring required

Candidate id returned by the completed job.

Response

Candidate preview audio.

Changes

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