Text To Speech (Speak)

Save a designed voice

Enroll the chosen candidate as a permanent voice_id, usable immediately in POST /v1/audio/speech (voice: vd_…) and in Omni agents. Requires the speak:design scope.

post/v1/voice/design/{id}/save

Request

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

Path parameters

idstring required

Design id.

Request body

candidate_idstring required
namestring required
metadataobject

Example request

{
  "candidate_id": "c1",
  "name": "Support, Nova"
}

Response

Saved voice

voice_idstring
namestring
sourcestring

Example response

{
  "voice_id": "vd_7h16k",
  "name": "Support, Nova",
  "source": "design"
}

Changes

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