Resolve a voice

POST

/v1/adapters/tts/voice/resolve

curl --request POST \
  --url https://example.com/v1/adapters/tts/voice/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "engine": "example", "name": "example", "language_code": "example", "model": "example", "gender": "example", "format": "example" }'

Resolves the active voice for the request, falling back to a compatible voice when the requested one is unavailable. The fallback flag in the response indicates whether a fallback was used.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

engine

required

string

name

required

string

language_code

required

string

model

string

gender

string

format

string

Example^generated

{
  "engine": "example",
  "name": "example",
  "language_code": "example",
  "model": "example",
  "gender": "example",
  "format": "example"
}

Responses

200

Resolved voice.

Media typeapplication/json

object

engine

required

string

name

required

string

model

required

string

language_code

required

string

gender

required

string

fallback

required

boolean

Example^generated

{
  "engine": "example",
  "name": "example",
  "model": "example",
  "language_code": "example",
  "gender": "example",
  "fallback": true
}

400

Error response.

Media typeapplication/json

object

code

required

string

reason

required

string

message

required

string

Example^generated

{
  "code": "example",
  "reason": "example",
  "message": "example"
}

401

Unauthorized

403

Forbidden

500

Error response.

Media typeapplication/json

object

code

required

string

reason

required

string

message

required

string

Example^generated

{
  "code": "example",
  "reason": "example",
  "message": "example"
}

502

Bad gateway (upstream adapter error)

503

Error response.

Media typeapplication/json

object

code

required

string

reason

required

string

message

required

string

Example^generated

{
  "code": "example",
  "reason": "example",
  "message": "example"
}