Get a collection of videos.
Returns the videos that the calling app has a license for, in the requested Accept-Language preferences, including parent language tags. An omitted header defaults to English. Explicit preferences do not fall back to English unless they include English. Each video is in the same shape as the video resource, and the response lists each video one time.
total_size is an upper bound on the number of videos across all pages. The response omits a video that is not available in the requested language, and total_size still counts it. So a page can hold fewer videos than page_size. Keep paging while next_page_token is present.
Send next_page_token back with the same Accept-Language as the request that produced it. A different value gives a 400. You can change page_size between pages.
The API returns 204 when the app has no license for any video. It does the same when no video matches the requested languages, and when the page is past the last page. Responses are private to the calling app.
query Parameters
page_sizeThe number of items to return in the collection. Must be between 1 and 99. Use the next_page_token from the response as page_token to retrieve the following page. Unlike page_size, this parameter has no unbounded * mode — collections using it are always paged.
page_tokenThe page token to retrieve results from.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get a collection of videos. › Responses
Successful request
total_sizeAn upper bound on the number of videos in the collection, across all pages. It counts a video that a page omits.
next_page_tokenToken to send to server when retrieving the next page of results. null on the last page.
Get a video resource by id.
Returns a video resource by its id. An unknown id, or a video that the calling app has no license for, returns 404. From then on, use the id in the response for this video. playback_sources holds its HLS source.
thumbnail.url is a Platform CDN URL. Its path carries this response's id and needs no app key, so load it as given. To select a resized rendition, add a size=thumb|card|full query parameter. Omit it for the full-size image.
path Parameters
video_idThe unique video ID provided in the Platform.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get a video resource by id. › Responses
Successful request
idThe video id issued for this response. Use it for this video from then on; the same video can carry a different id in each response, so do not use it as a stable key for the video.
Playable sources for the video.
Preview clip sources.
organization_idThe id of the organization that publishes the video. Null when the publisher is not known.
titleVideo title.
descriptionVideo description.
passage_idsThe Bible passages the video is about. Each is a chapter, verse or verse range such as GEN.1, JHN.3.16 or 1CO.13.4-5. Null when the video has no passage.
language_tagBCP 47 language tag for the video.
runtimeRuntime in seconds.
orientationVideo orientation.
share_urlShare URL for the video.