Get the metadata for a specified VideoPress video.
Resource Information
Method
GET
URL
https://public-api.wordpress.com/rest/v1.1/videos/$guid
Requires authentication?
No
Method Parameters
Parameter
Type
Description
$guid
(string)
The guid of the video
Query Parameters
Parameter
Type
Description
context
(string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope
(bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty
(bool)
false:
(default)
true:
Output pretty JSON
meta
(string)
Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields
(string)
Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback
(string)
An optional JSONP callback function.
birth_month
(int)
The month the visitor was born
birth_day
(int)
The day of the month the visitor was born
birth_year
(int)
The year the visitor was born
metadata_token
(string)
Optional. Permissions token
Response Parameters
Parameter
Type
Description
title
(string)
Title of the video
description
(string)
Description of the video
width
(int)
Width of the video
height
(int)
Height of the video
duration
(int)
The length of the video, in milliseconds
display_embed
(bool)
Should the embed menu be shown?
allow_download
(bool)
Whether to display and allow video downloads
rating
(string)
The rating of the video
privacy_setting
(int)
The privacy level for the video
poster
(string)
The URL of the video image
original
(string)
The URL of the original video
watermark
(string)
URL of a watermark logo
bg_color
(string)
Custom background color
files
(array)
List of video formats and the associated filenames
file_url_base
(array)
List of protocols and the base needed for creating file URLs
blog_id
(int)
Blog ID of the site where the video was uploaded
post_id
(int)
Post ID of the video attachment post
upload_date
(string)
Date the video was uploaded in ISO 8601 format
finished
(bool)
Is video transcoding finished?
files_status
(array)
Transcoding status for each video file format
subtitles
(array)
Available subtitle formats with information for each language that is available
Resource Errors
This endpoint does not return any errors.
Example
curl 'https://public-api.wordpress.com/rest/v1.1/videos/OO4thna8?birth_month=1&birth_day=1&birth_year=2000'
<?php
$options = array (
'http' =>
array (
'ignore_errors' => true,
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'https://public-api.wordpress.com/rest/v1.1/videos/OO4thna8?birth_month=1&birth_day=1&birth_year=2000',
false,
$context
);
$response = json_decode( $response );
?>
