WIwistia
Extended Audio Descriptions

Order Extended Audio Description

Changed on

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.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the order-audio-descriptions permission on the media can also be used. The order is attributed to the contact the token was created for.

post/media_extended_audio_descriptions/order

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/media_extended_audio_descriptions/order
  • Auth
    HTTP bearer

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). AI is only available for English orders.

order_instructionsstring

Optional instructions for the audio description provider.

ietf_language_tag'eng' | 'es-419'

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.

Response

Extended audio description ordered successfully.

messagestring required

Success message indicating the order has been placed.

expected_billed_creditsstring nullable required

The credits held for the audio description, deducted when it completes. Null when the audio description is not paid for with credits. Decimal amounts are returned as strings.

Example response

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

Changes

  • b86cb2a7b420Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status