Order Extended Audio Description
order_extended_audio_descriptionEnhance media accessibility by ordering extended audio descriptions. Requires confirmation and a paid plan with the feature; charges apply.
Instructions
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.
Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| confirm | No | Must be true for the specific user-requested write. | |
| enabled | No | Whether the extended audio description should be automatically enabled once the order is complete. | |
| payload | No | Complete JSON request body instead of body flags. Supports current nested customization, caption and nullable values. | |
| media_id | No | The hashed id of the media to order the extended audio description for. | |
| ai_enabled | No | Whether to use AI-generated audio descriptions (cheaper) or human-generated (higher quality). AI is only available for English orders. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| ietf_language_tag | No | IETF language tag for the audio description. Defaults to `eng` (English). Non-English orders must set `ai_enabled: false` — AI-generated audio descriptions are only available in English. Spanish (`es-419`) orders are only accepted when the source media is tagged as a Spanish-language variant or has no detected language (e.g. silent videos). Spanish orders against a media in another language return `400`. | eng |
| order_instructions | No | Optional instructions for the audio description provider. |