WIwistia
Captions

Purchase Captions

Changed on

This method is for purchasing English captions for a media. The request will charge the credit card on the account if successful. A saved credit card is required to use this endpoint.

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the create-transcripts permission on this media can also be used.

post/medias/{mediaHashedId}/captions/purchase

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/medias/{mediaHashedId}/captions/purchase
  • Auth
    HTTP bearer

Path parameters

mediaHashedIdstring required

Unique identifier for the media.

Headers

X-Wistia-API-Versionstring required

Request body

automatedboolean

Order computer-generated captions or human-reviewed ones. What each costs depends on the account's plan and billing settings; computer-generated captions are included at no cost on some plans and billed per minute on others.

rushboolean

Enable rush order for one business day turnaround instead of the standard four, for human-reviewed captions only. Rush bills at the account's higher per-minute rate.

automatically_enableboolean

Automatically enable captions for the media once the order is ready or hold the captions for review before manually enabling.

Response

Successful operation. Captions purchased.

messagestring required

Success message indicating the captions have been purchased

idstring required

The unique hashed identifier of the time-coded transcript that was created

Example response

{
  "message": "Captions purchased for this video. Your account will be charged when the captions are ready.",
  "id": "abc123def456"
}

Changes