Documentation/Speech generation

Speech generation

Behavior

The actual response is binary audio, not this JSON illustration. Save it and inspect Content-Type.

Endpoint and authentication

POST /v1/audio/speech

Use an XHub API key: Authorization: Bearer . Do not use upstream provider credentials as gateway keys.

Use the gateway root Base URL shown in the playground, without appending /v1; send requests to the full endpoint path above.

Request example

curl "$XHUB_BASE_URL/v1/audio/speech" \
  -H "Authorization: Bearer $XHUB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"YOUR_MODEL_NAME","input":"Hello, welcome to XHub.","voice":"alloy"}' --output speech.mp3

Request parameters

Field Type Description
model string · required Public model name; deployment must support this protocol.
input / voice string · required Text and supported voice ID.
response_format / speed string / number Output format and supported speech speed.

Success response

{
  "note": "Binary audio response"
}
Field Type
note string

Errors and troubleshooting

HTTP Meaning
400 Invalid request. Check JSON, parameters and query.
401 Missing or invalid XHub credential.
403 Permission denied. Check model scope or policy.
429 Limit exceeded. Inspect response details and Retry-After.

Search full documentation: budgets, routing, Docker…