Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the
Accept header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't.
All GitHub Enterprise Server media types look like this:
The most basic media types the API supports are:
Neither of these specify a version, so you will always get the current default JSON representation of resources.
Important: The default version of the API may change in the future. If you're building an application and care about the stability of the API, be sure to request a specific version in the
Accept header as shown in the examples below.
You can specify a version like so:
If you're specifying a property (such as full/raw/etc defined below), put the version before the property:
You can check the current version through every response's headers. Look for the
$ curl http(s)://[hostname]/api/v3/users/technoweenie -I > HTTP/1.1 200 OK > X-GitHub-Media-Type: github.v3 $ curl http(s)://[hostname]/api/v3/users/technoweenie -I \ $ -H "Accept: application/vnd.github.full+json" > HTTP/1.1 200 OK > X-GitHub-Media-Type: github.v3; param=full; format=json $ curl http(s)://[hostname]/api/v3/users/technoweenie -I \ $ -H "Accept: application/vnd.github.v3.full+json" > HTTP/1.1 200 OK > X-GitHub-Media-Type: github.v3; param=full; format=json
Comment body properties
The body of a comment can be written in GitHub Flavored Markdown, issues, issue comments, pull request comments, and the gist comments APIs all accept these same media types:
Return the raw markdown body. Response will include
body. This is the default if you do not pass any specific media type.
Return a text only representation of the markdown body. Response will include
Return HTML rendered from the body's markdown. Response will include
Return raw, text and HTML representations. Response will include
Git blob properties
The following media types are allowed when getting a blob:
Return JSON representation of the blob with
content as a base64 encoded string. This is the default if nothing is passed.
Return the raw blob data.
Commits, commit comparison, and pull requests
The commits API and pull requests API support diff and patch formats:
Return the raw contents of a file. This is the default if you do not pass any specific media type.
For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the
.html media type. Markup languages are rendered to HTML using our open-source Markup library.
Return the raw contents of a gist. This is the default if you do not pass any specific media type.
The gist contents are base64-encoded before being sent out. This can be useful if your gist contains any invalid UTF-8 sequences.