Resource Information
Method | GET |
---|---|
URL | https://public-api.wordpress.com/rest/v1.1/sites/$site/media/$media_ID |
Requires authentication? | Yes |
Method Parameters
Parameter | Type | Description |
---|---|---|
$site | (int|string) | Site ID or domain |
$media_ID | (int) | The ID of the media item |
Query Parameters
Parameter | Type | Description |
---|---|---|
context | (string) |
|
http_envelope | (bool) |
|
pretty | (bool) |
|
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. |
Response Parameters
Parameter | Type | Description |
---|---|---|
ID | (int) | The ID of the media item |
date | (iso 8601 datetime) | The date the media was uploaded |
post_ID | (int) | ID of the post this media is attached to |
author_ID | (int) | ID of the user who uploaded the media |
URL | (string) | URL to the file |
guid | (string) | Unique identifier |
file | (string) | Filename |
extension | (string) | File extension |
mime_type | (string) | File MIME type |
title | (string) | Filename |
caption | (string) | User-provided caption of the file |
description | (string) | Description of the file |
alt | (string) | Alternative text for image files. |
thumbnails | (object) | Media item thumbnail URL options |
height | (int) | (Image & video only) Height of the media item |
width | (int) | (Image & video only) Width of the media item |
length | (int) | (Video & audio only) Duration of the media item, in seconds |
exif | (array) | (Image & audio only) Exif (meta) information about the media item |
videopress_guid | (string) | (Video only) VideoPress GUID of the video when uploaded on a blog with VideoPress |
videopress_processing_done | (bool) | (Video only) If the video is uploaded on a blog with VideoPress, this will return the status of processing on the video. |
Resource Errors
These are the possible errors returned by this endpoint.
HTTP Code | Error Identifier | Error Message |
---|---|---|
403 | unauthorized | User cannot access this private blog. |
403 | unauthorized | User cannot access this restricted blog |
404 | unknown_media | Unknown Media |
403 | unauthorized | User cannot view media |
Example
curl \ -H 'authorization: Bearer YOUR_API_TOKEN' \ 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/934'
<?php $options = array ( 'http' => array ( 'ignore_errors' => true, 'header' => array ( 0 => 'authorization: Bearer YOUR_API_TOKEN', ), ), ); $context = stream_context_create( $options ); $response = file_get_contents( 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/934', false, $context ); $response = json_decode( $response ); ?>
Response
{ "ID": 934, "URL": "https:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png", "guid": "http:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png", "date": "2015-04-19T15:53:38+00:00", "post_ID": 0, "author_ID": 422, "file": "screen-shot-2015-04-19-at-8-53-25-am.png", "mime_type": "image\/png", "extension": "png", "title": "Test Image", "caption": "", "description": "testing.", "alt": "", "icon": "https:\/\/s1.wp.com\/wp-includes\/images\/media\/default.png", "thumbnails": { "thumbnail": "https:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png?w=150", "medium": "https:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png?w=300", "large": "https:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png?w=810", "post-thumbnail": "https:\/\/apiexamples.files.wordpress.com\/2015\/04\/screen-shot-2015-04-19-at-8-53-25-am.png?w=810&h=260&crop=1" }, "height": 384, "width": 810, "exif": { "aperture": 0, "credit": "", "camera": "", "caption": "", "created_timestamp": 0, "copyright": "", "focal_length": 0, "iso": 0, "shutter_speed": 0, "title": "", "orientation": 0 }, "meta": { "links": { "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/media\/934", "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/media\/934\/help", "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409" } } }