v1

latestOpenAPI 3.1.12026-07-2410095.4 KB

Extended Audio Descriptions

Order Extended Audio Description

Orders an extended audio description for a media. The request will charge the credit card on the account when the order is ready. Only accounts on paid plans with the order_audio_descriptions feature can use this endpoint.

post/media_extended_audio_descriptions/order

Headers

X-Wistia-API-Versionstring required

Request body

media_idstring required

The hashed id of the media to order the extended audio description for.

enabledboolean

Whether the extended audio description should be automatically enabled once the order is complete.

ai_enabledboolean

Whether to use AI-generated audio descriptions (cheaper) or human-generated (higher quality).

order_instructionsstring

Optional instructions for the audio description provider.

Response

Extended audio description ordered successfully.

messagestring required

Success message indicating the order has been placed.

Example response

{
  "message": "Extended audio description ordered. Your account will be charged when the order is ready."
}