Create Speech Generation

Start a speech generation with the selected model. Charged per character via text-to-speech billing. Use this over /v1/text-to-speech for the asynchronous generation lifecycle or for models not offered there; for direct, synchronous speech synthesis, prefer /v1/text-to-speech.

post/v1/flows/text-to-speech

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Example request

{
  "webhook": {
    "ids": [
      "Q8mVr2LpXcT4nB6yJdKw"
    ]
  },
  "text": "The first move is what sets everything in motion.",
  "voice": "JBFqnCBsd6RMkjVDRZzb",
  "pronunciation_dictionary_locators": [
    {
      "pronunciation_dictionary_id": "5xM3yVvZQKV0EfqQpLrJ"
    }
  ],
  "language_code": "en"
}

Response

Successful Response

idstring required

The unique identifier of the generation. Pass it to the corresponding GET endpoint to retrieve the output.

status'pending' required

A newly created generation is always pending.

Example response

{
  "id": "JWr5N6X9ZTqf8jD2LmQb",
  "status": "pending"
}

Changes

Changed in 2 of the 49 revisions of this API.67

Sep 22, 20266fb9be1a19f566See the full diff
- ▲
  the request property /////// became required
  request-property-became-required
- ▲
  the request property /////// became required
  request-property-became-required
- ▲
  the request property /////// became required
  request-property-became-required
- ▲
  the request property /////// became required
  request-property-became-required
- ▲
  the request property /////// became required
  request-property-became-required
- ▲
  the request property /////// became required
  request-property-became-required
- ○
  the request property default value all was removed
  request-property-default-value-removed
- ○
  the request property default value all was removed
  request-property-default-value-removed
- ○
  the request property default value all was removed
  request-property-default-value-removed
- ○
  the request property default value ids was removed
  request-property-default-value-removed
- ○
  the request property default value ids was removed
  request-property-default-value-removed
- ○
  the request property default value ids was removed
  request-property-default-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 20266c2d6eb4a7e61See the full diff
- ○
  endpoint added
  endpoint-added

Full history