WIwistia
Captions

Find Caption Matches

Changed on

Finds exact text in caption tracks without modifying them. Matching uses the same normalization, composite-media boundaries, and time coordinates as the targeted caption edit endpoint. Fuzzy alternatives are returned separately as suggestions and are never reported as exact matches. A resolved match means the wording was located; a later write can still fail authorization, version, or edit-boundary checks.

When more than 10 exact matches exist, use the one-based occurrence parameter to retrieve a specific later match.

Authentication and request validation failures apply to the whole request. Missing, inaccessible, or otherwise unreadable media are reported as per-media statuses without exposing whether an inaccessible ID exists.

Requires api token with one of the following permissions

Read all folder and media data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used.

post/caption_matches

Request

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

Headers

X-Wistia-API-Versionstring required

Request body

media_idsstring[] required

Explicit hashed IDs of the media whose captions should be searched.

target_textstring required

Exact caption wording to locate.

language_codestring

Exact IETF language tag. Omit when each media has only one caption track.

occurrenceinteger

One-based exact occurrence to return, including occurrences after the first 10.

start_msinteger

Optional start of a time range used to disambiguate the match.

end_msinteger

Optional end of a time range used to disambiguate the match.

Response

Every requested media ID was processed; inspect each result's status.

requested_countinteger required
succeeded_countinteger required

Number of media whose transcript search was processed successfully, whether or not an exact match was found.

failed_countinteger required

Number of media that returned a non-ok per-media status.

completeboolean required

True when every requested media ID was processed, including per-media negative results.

Changes