{"id":23116,"date":"2016-12-06T18:10:21","date_gmt":"2016-12-06T18:10:21","guid":{"rendered":"https:\/\/developer.wordpress.org\/?post_type=rest-api-handbook&p=23116"},"modified":"2024-01-16T20:30:18","modified_gmt":"2024-01-16T20:30:18","slug":"media","status":"publish","type":"rest-api-handbook","link":"https:\/\/developer.wordpress.org\/rest-api\/reference\/media\/","title":{"rendered":"Media"},"content":{"rendered":"
\n
\n

Schema<\/h2>\n

The schema defines all the fields that exist within a Media Item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n date<\/code>\n <\/td>\n\n The date the post was published, in the site's timezone.<\/p>\n

\n JSON data type: string or null,
\n Format: datetime (details<\/a>)\n <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n date_gmt<\/code>\n <\/td>\n\n The date the post was published, as GMT.<\/p>\n

\n JSON data type: string or null,
\n Format: datetime (details<\/a>)\n <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n guid<\/code>\n <\/td>\n\n The globally unique identifier for the post.<\/p>\n

\n JSON data type: object <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n id<\/code>\n <\/td>\n\n Unique identifier for the post.<\/p>\n

\n JSON data type: integer <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n link<\/code>\n <\/td>\n\n URL to the post.<\/p>\n

\n JSON data type: string,
\n Format: uri\n <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n modified<\/code>\n <\/td>\n\n The date the post was last modified, in the site's timezone.<\/p>\n

\n JSON data type: string,
\n Format: datetime (details<\/a>)\n <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n modified_gmt<\/code>\n <\/td>\n\n The date the post was last modified, as GMT.<\/p>\n

\n JSON data type: string,
\n Format: datetime (details<\/a>)\n <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n slug<\/code>\n <\/td>\n\n An alphanumeric identifier for the post unique to its type.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n status<\/code>\n <\/td>\n\n A named status for the post.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n

One of: publish<\/code>, future<\/code>, draft<\/code>, pending<\/code>, private<\/code>\n <\/td>\n<\/tr>\n

\n type<\/code>\n <\/td>\n\n Type of post.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n generated_slug<\/code>\n <\/td>\n\n Slug automatically generated from the post title.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n title<\/code>\n <\/td>\n\n The title for the post.<\/p>\n

\n JSON data type: object <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n author<\/code>\n <\/td>\n\n The ID for the author of the post.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n comment_status<\/code>\n <\/td>\n\n Whether or not comments are open on the post.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n

One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n

\n ping_status<\/code>\n <\/td>\n\n Whether or not the post can be pinged.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n

One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n

\n meta<\/code>\n <\/td>\n\n Meta fields.<\/p>\n

\n JSON data type: object <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n template<\/code>\n <\/td>\n\n The theme file to use to display the post.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n alt_text<\/code>\n <\/td>\n\n Alternative text to display when attachment is not displayed.<\/p>\n

\n JSON data type: string <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n caption<\/code>\n <\/td>\n\n The attachment caption.<\/p>\n

\n JSON data type: object <\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n description<\/code>\n <\/td>\n\n The attachment description.<\/p>\n

\n JSON data type: object <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n media_type<\/code>\n <\/td>\n\n Attachment type.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n

One of: image<\/code>, file<\/code>\n <\/td>\n<\/tr>\n

\n mime_type<\/code>\n <\/td>\n\n The attachment MIME type.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n media_details<\/code>\n <\/td>\n\n Details about the media file, specific to its type.<\/p>\n

\n JSON data type: object <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n post<\/code>\n <\/td>\n\n The ID for the associated post of the attachment.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n source_url<\/code>\n <\/td>\n\n URL to the original attachment file.<\/p>\n

\n JSON data type: string,
\n Format: uri\n <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n missing_image_sizes<\/code>\n <\/td>\n\n List of the missing image sizes of the attachment.<\/p>\n

\n JSON data type: array <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n
\n

List Media<\/h2>\n

Query this endpoint to retrieve a collection of media. The response you receive can be controlled and filtered using the URL query parameters below.<\/p>\n

Definition<\/h3>\n

GET \/wp\/v2\/media<\/code><\/p>\n

Example Request<\/h3>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/media<\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n

\n page<\/code>\n <\/td>\n\n Current page of the collection.<\/p>\n

\n Default: 1<\/code>\n <\/p>\n<\/td>\n<\/tr>\n

\n per_page<\/code>\n <\/td>\n\n Maximum number of items to be returned in result set.<\/p>\n

\n Default: 10<\/code>\n <\/p>\n<\/td>\n<\/tr>\n

\n search<\/code>\n <\/td>\n\n Limit results to those matching a string.\n <\/td>\n<\/tr>\n
\n after<\/code>\n <\/td>\n\n Limit response to posts published after a given ISO8601 compliant date.\n <\/td>\n<\/tr>\n
\n modified_after<\/code>\n <\/td>\n\n Limit response to posts modified after a given ISO8601 compliant date.\n <\/td>\n<\/tr>\n
\n author<\/code>\n <\/td>\n\n Limit result set to posts assigned to specific authors.\n <\/td>\n<\/tr>\n
\n author_exclude<\/code>\n <\/td>\n\n Ensure result set excludes posts assigned to specific authors.\n <\/td>\n<\/tr>\n
\n before<\/code>\n <\/td>\n\n Limit response to posts published before a given ISO8601 compliant date.\n <\/td>\n<\/tr>\n
\n modified_before<\/code>\n <\/td>\n\n Limit response to posts modified before a given ISO8601 compliant date.\n <\/td>\n<\/tr>\n
\n exclude<\/code>\n <\/td>\n\n Ensure result set excludes specific IDs.\n <\/td>\n<\/tr>\n
\n include<\/code>\n <\/td>\n\n Limit result set to specific IDs.\n <\/td>\n<\/tr>\n
\n offset<\/code>\n <\/td>\n\n Offset the result set by a specific number of items.\n <\/td>\n<\/tr>\n
\n order<\/code>\n <\/td>\n\n Order sort attribute ascending or descending.<\/p>\n

\n Default: desc<\/code>\n <\/p>\n

One of: asc<\/code>, desc<\/code>\n <\/td>\n<\/tr>\n

\n orderby<\/code>\n <\/td>\n\n Sort collection by post attribute.<\/p>\n

\n Default: date<\/code>\n <\/p>\n

One of: author<\/code>, date<\/code>, id<\/code>, include<\/code>, modified<\/code>, parent<\/code>, relevance<\/code>, slug<\/code>, include_slugs<\/code>, title<\/code>\n <\/td>\n<\/tr>\n

\n parent<\/code>\n <\/td>\n\n Limit result set to items with particular parent IDs.\n <\/td>\n<\/tr>\n
\n parent_exclude<\/code>\n <\/td>\n\n Limit result set to all items except those of a particular parent ID.\n <\/td>\n<\/tr>\n
\n search_columns<\/code>\n <\/td>\n\n Array of column names to be searched.\n <\/td>\n<\/tr>\n
\n slug<\/code>\n <\/td>\n\n Limit result set to posts with one or more specific slugs.\n <\/td>\n<\/tr>\n
\n status<\/code>\n <\/td>\n\n Limit result set to posts assigned one or more statuses.<\/p>\n

\n Default: inherit<\/code>\n <\/p>\n<\/td>\n<\/tr>\n

\n media_type<\/code>\n <\/td>\n\n Limit result set to attachments of a particular media type.
\n One of: image<\/code>, video<\/code>, text<\/code>, application<\/code>, audio<\/code>\n <\/td>\n<\/tr>\n
\n mime_type<\/code>\n <\/td>\n\n Limit result set to attachments of a particular MIME type.\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n
\n
\n

Create a Media Item<\/h2>\n

Arguments<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n date<\/a><\/code>\n <\/td>\n\n The date the post was published, in the site's timezone.\n <\/td>\n<\/tr>\n
\n date_gmt<\/a><\/code>\n <\/td>\n\n The date the post was published, as GMT.\n <\/td>\n<\/tr>\n
\n slug<\/a><\/code>\n <\/td>\n\n An alphanumeric identifier for the post unique to its type.\n <\/td>\n<\/tr>\n
\n status<\/a><\/code>\n <\/td>\n\n A named status for the post.
\n One of: publish<\/code>, future<\/code>, draft<\/code>, pending<\/code>, private<\/code>\n <\/td>\n<\/tr>\n
\n title<\/a><\/code>\n <\/td>\n\n The title for the post.\n <\/td>\n<\/tr>\n
\n author<\/a><\/code>\n <\/td>\n\n The ID for the author of the post.\n <\/td>\n<\/tr>\n
\n comment_status<\/a><\/code>\n <\/td>\n\n Whether or not comments are open on the post.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n ping_status<\/a><\/code>\n <\/td>\n\n Whether or not the post can be pinged.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n meta<\/a><\/code>\n <\/td>\n\n Meta fields.\n <\/td>\n<\/tr>\n
\n template<\/a><\/code>\n <\/td>\n\n The theme file to use to display the post.\n <\/td>\n<\/tr>\n
\n alt_text<\/a><\/code>\n <\/td>\n\n Alternative text to display when attachment is not displayed.\n <\/td>\n<\/tr>\n
\n caption<\/a><\/code>\n <\/td>\n\n The attachment caption.\n <\/td>\n<\/tr>\n
\n description<\/a><\/code>\n <\/td>\n\n The attachment description.\n <\/td>\n<\/tr>\n
\n post<\/a><\/code>\n <\/td>\n\n The ID for the associated post of the attachment.\n <\/td>\n<\/tr>\n<\/table><\/div>\n
\n

Definition<\/h3>\n

POST \/wp\/v2\/media<\/code>\n <\/div>\n<\/section>\n

\n
\n

Retrieve a Media Item<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/media\/<id><\/code><\/p>\n

Query this endpoint to retrieve a specific Media Item record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/media\/<id><\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n\n
\n id<\/code>\n <\/td>\n\n Unique identifier for the post.\n <\/td>\n<\/tr>\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n

Update a Media Item<\/h2>\n

Arguments<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n id<\/a><\/code>\n <\/td>\n\n Unique identifier for the post.\n <\/td>\n<\/tr>\n
\n date<\/a><\/code>\n <\/td>\n\n The date the post was published, in the site's timezone.\n <\/td>\n<\/tr>\n
\n date_gmt<\/a><\/code>\n <\/td>\n\n The date the post was published, as GMT.\n <\/td>\n<\/tr>\n
\n slug<\/a><\/code>\n <\/td>\n\n An alphanumeric identifier for the post unique to its type.\n <\/td>\n<\/tr>\n
\n status<\/a><\/code>\n <\/td>\n\n A named status for the post.
\n One of: publish<\/code>, future<\/code>, draft<\/code>, pending<\/code>, private<\/code>\n <\/td>\n<\/tr>\n
\n title<\/a><\/code>\n <\/td>\n\n The title for the post.\n <\/td>\n<\/tr>\n
\n author<\/a><\/code>\n <\/td>\n\n The ID for the author of the post.\n <\/td>\n<\/tr>\n
\n comment_status<\/a><\/code>\n <\/td>\n\n Whether or not comments are open on the post.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n ping_status<\/a><\/code>\n <\/td>\n\n Whether or not the post can be pinged.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n meta<\/a><\/code>\n <\/td>\n\n Meta fields.\n <\/td>\n<\/tr>\n
\n template<\/a><\/code>\n <\/td>\n\n The theme file to use to display the post.\n <\/td>\n<\/tr>\n
\n alt_text<\/a><\/code>\n <\/td>\n\n Alternative text to display when attachment is not displayed.\n <\/td>\n<\/tr>\n
\n caption<\/a><\/code>\n <\/td>\n\n The attachment caption.\n <\/td>\n<\/tr>\n
\n description<\/a><\/code>\n <\/td>\n\n The attachment description.\n <\/td>\n<\/tr>\n
\n post<\/a><\/code>\n <\/td>\n\n The ID for the associated post of the attachment.\n <\/td>\n<\/tr>\n<\/table><\/div>\n
\n

Definition<\/h3>\n

POST \/wp\/v2\/media\/<id><\/code><\/p>\n

Example Request<\/h3>\n

<\/code>\n <\/div>\n<\/section>\n

\n
\n

Delete a Media Item<\/h2>\n

Arguments<\/h3>\n\n\n\n
\n id<\/code>\n <\/td>\n\n Unique identifier for the post.\n <\/td>\n<\/tr>\n
\n force<\/code>\n <\/td>\n\n Whether to bypass Trash and force deletion.\n <\/td>\n<\/tr>\n<\/table><\/div>\n
\n

Definition<\/h3>\n

DELETE \/wp\/v2\/media\/<id><\/code><\/p>\n

Example Request<\/h3>\n

$ curl -X DELETE https:\/\/example.com\/wp-json\/wp\/v2\/media\/<id><\/code>\n <\/div>\n<\/section>\n<\/div>\n","protected":false},"author":5896197,"featured_media":0,"parent":23078,"menu_order":0,"template":"","meta":{"_crdt_document":"","footnotes":""},"class_list":["post-23116","rest-api-handbook","type-rest-api-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23116","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/rest-api-handbook"}],"author":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/users\/5896197"}],"version-history":[{"count":16,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23116\/revisions"}],"predecessor-version":[{"id":152006,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23116\/revisions\/152006"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23078"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=23116"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}