Find Caption Matches
find_caption_matchesLocate exact caption text in Wistia media without editing. Returns matches with time coordinates and keeps fuzzy suggestions separate.
Instructions
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 dataTokens with the "Act with a team member's permissions" permission
(all:delegate_to_contact_permissions scope) can also be used.
Read-only account operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_ms | No | Optional end of a time range used to disambiguate the match. | |
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| payload | No | Complete JSON request body instead of body flags. Supports current nested customization, caption and nullable values. | |
| start_ms | No | Optional start of a time range used to disambiguate the match. | |
| media_ids | No | Explicit hashed IDs of the media whose captions should be searched. | |
| occurrence | No | One-based exact occurrence to return, including occurrences after the first 10. | |
| target_text | No | Exact caption wording to locate. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| language_code | No | Exact IETF language tag. Omit when each media has only one caption track. |