beatraドキュメント

クローンした音色またはアカウントの既定音色を更新する

以下のエンドポイント仕様（パラメーター、リクエスト、レスポンス）は英語の原文です。フィールド名は API と同じです。

PATCH
/v1/voices/{voice_id}

Request Body

application/jsonRequired
display_nameDisplay Name

New display name for a cloned voice belonging to this account

make_defaultMake Default

True sets this voice as the account default; false clears the account default when it is currently this voice; omit to leave default selection unchanged.

genderGender

Speaker gender tag (male, female, or neutral); send null to clear

age_groupAge Group

Speaker age group (child, youth, adult, or senior); send null to clear

use_caseUse Case

Recommended scenarios for this cloned voice (up to 5 items); send null or [] to clear

personaPersona

Short description of timbre, pace, and character (up to 200 characters); send null to clear

languageLanguage

Primary BCP-47 language code for this cloned voice; send null to clear

Path Parameters

voice_id
Required
Voice Id

Header Parameters

Authorization
Required
string

Bearer API key.

X-Request-Idstring

Optional client request id echoed in the response.

curl -X PATCH "https://api.beatra.ai/v1/voices/string" \
  -H "Authorization: string" \
  -H "X-Request-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "string",
    "make_default": true,
    "gender": "male",
    "age_group": "child",
    "use_case": [
      "audiobook"
    ],
    "persona": "string",
    "language": "string"
  }'

Successful Response

{
  "voice_id": "string",
  "display_name": "string",
  "category": "preset",
  "language": "string",
  "languages_supported": [
    "string"
  ],
  "subtitles": false,
  "gender": "male",
  "age_group": "string",
  "accent": "string",
  "use_case": [
    "string"
  ],
  "persona": "string",
  "preview_url": "string",
  "preview_url_scene": "string",
  "compatible_models": [
    "string"
  ],
  "status": "processing",
  "created_at": "2019-08-24T14:15:22Z",
  "preview": {
    "url": "string",
    "text": "string",
    "language": "string",
    "version": 0
  },
  "activation": {
    "required": true,
    "price_credits": 0,
    "quote": {
      "voice_id": "string",
      "price_credits": 0,
      "balance_credits": "string",
      "sufficient_balance": true,
      "preview": {
        "url": "string",
        "text": "string",
        "language": "string",
        "version": 0
      },
      "confirmation_token": "string",
      "token_expires_at": "2019-08-24T14:15:22Z",
      "terms_version": "string",
      "terms": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "message": "string"
    }
  },
  "expires_at": "2019-08-24T14:15:22Z",
  "clone_model": "string",
  "retirement": {
    "retire_at": "2019-08-24T14:15:22Z",
    "replacement_voice_id": "string"
  }
}

最終更新