WIwistia
Captions

Edit Captions Text

Changed on

Applies targeted find-and-replace corrections to a media's transcript for the specified language, preserving the timings of unchanged words. The whole batch is applied atomically against a specific caption version, or nothing is.

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 edit-transcripts permission on this media can also be used. When the media is a composite whose captions belong to another media, the token also needs edit-transcripts on that media.

post/medias/{mediaHashedId}/captions/{languageCode}/edits

Request

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

Path parameters

mediaHashedIdstring required

The hashed ID of the media whose transcript should be edited.

languageCodestring required

The 3-character ISO 639-2 language code of the caption track to edit (e.g., eng, fra, spa). Some languages use extended IETF subtags (e.g., zh-Hant).

Headers

X-Wistia-API-Versionstring required

Request body

expected_versioninteger required

The active caption version returned with the caption content used to prepare these edits. The edit applies only if that is still the active version; otherwise it returns 409 so you re-read and retry.

Response

Corrections applied; a new caption version was written.

appliedboolean required

Always true on a 200; the whole batch was applied.

media_idstring required

The hashed ID of the media whose transcript was edited. Differs from the path media when the transcript is projected from a composite recording.

languagestring required

The ISO-639-2 language tag of the edited caption track.

warningsstring[] required

Non-fatal advisories, usually empty. For a Remix output, these may identify source media whose transcripts can be edited.

Changes