Create a gist - GitHub v3 REST API

Allows you to add a new gist with one or more files.

Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

curl --location --request POST 'https://api.github.com/gists' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "Example of a gist", "files": { "README.md": { "content": "Hello World" } }, "public": false }'

{ "comments": 0, "comments_url": "string", "commits_url": "string", "created_at": "string", "description": "string", "files": { "property1": { "content": "string", "filename": "string", "language": "string", "raw_url": "string", "size": 0, "truncated": true, "type": "string" }, "property2": { "content": "string", "filename": "string", "language": "string", "raw_url": "string", "size": 0, "truncated": true, "type": "string" } }, "fork_of": { "comments": 0, "comments_url": "http://example.com", "commits_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z", "description": "string", "files": { "property1": { "filename": "string", "language": "string", "raw_url": "string", "size": 0, "type": "string" }, "property2": { "filename": "string", "language": "string", "raw_url": "string", "size": 0, "type": "string" } }, "forks": [ null ], "forks_url": "http://example.com", "git_pull_url": "http://example.com", "git_push_url": "http://example.com", "history": [ null ], "html_url": "http://example.com", "id": "string", "node_id": "string", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "public": true, "truncated": true, "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } }, "forks": [ { "created_at": "2019-08-24T14:15:22Z", "id": "string", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "user": { "avatar_url": "http://example.com", "bio": "string", "blog": "string", "collaborators": 3, "company": "string", "created_at": "2019-08-24T14:15:22Z", "disk_usage": 1, "email": "user@example.com", "events_url": "string", "followers": 0, "followers_url": "http://example.com", "following": 0, "following_url": "string", "gists_url": "string", "gravatar_id": "string", "hireable": true, "html_url": "http://example.com", "id": 0, "location": "string", "login": "string", "name": "string", "node_id": "string", "organizations_url": "http://example.com", "owned_private_repos": 2, "plan": { "collaborators": 0, "name": "string", "private_repos": 0, "space": 0 }, "private_gists": 1, "public_gists": 0, "public_repos": 0, "received_events_url": "http://example.com", "repos_url": "http://example.com", "site_admin": true, "starred_url": "string", "subscriptions_url": "http://example.com", "suspended_at": "2019-08-24T14:15:22Z", "total_private_repos": 2, "twitter_username": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com" } } ], "forks_url": "string", "git_pull_url": "string", "git_push_url": "string", "history": [ { "change_status": { "additions": 0, "deletions": 0, "total": 0 }, "committed_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "version": "string" } ], "html_url": "string", "id": "string", "node_id": "string", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "public": true, "truncated": true, "updated_at": "string", "url": "string", "user": "string" }

Request

Body Params application/json

description

string

optional

Description of the gist

Example:

Example Ruby script

files

object

required

Names and content for the files that make up the gist

Example:

{"hello.rb":{"content":"puts \"Hello, World!\""}}

Additional properties

object

optional

public

optional

One of

boolean

string

Flag indicating whether the gist is public

Default:

false

Example:

true

Examples

Responses

🟢201Response

application/json

Body

Gist Simple

comments

integer

optional

comments_url

string

optional

commits_url

string

optional

created_at

string

optional

description

string | null

optional

files

object

optional

Additional properties

object | null

optional

fork_of

object | null

Gist

optional

Gist

comments

integer

required

comments_url

string <uri>

required

commits_url

string <uri>

required

created_at

string <date-time>

required

description

string | null

required

files

object

required

forks

array

optional

forks_url

string <uri>

required

git_pull_url

string <uri>

required

git_push_url

string <uri>

required

history

array

optional

html_url

string <uri>

required

string

required

node_id

string

required

owner

object (Simple User) | null

optional

A GitHub user.

public

boolean

required

truncated

boolean

optional

updated_at

string <date-time>

required

url

string <uri>

required

user

object (Simple User) | null

required

A GitHub user.

forks

array [object {5}] | null

deprecated

created_at

string <date-time>

deprecated

string

deprecated

updated_at

string <date-time>

deprecated

url

string <uri>

deprecated

user

object (Public User)

deprecated

Public User

forks_url

string

optional

git_pull_url

string

optional

git_push_url

string

optional

history

array[object (Gist History) {5}] | null

deprecated

change_status

object

deprecated

committed_at

string <date-time>

deprecated

url

string <uri>

deprecated

user

object (Simple User) | null

deprecated

A GitHub user.

version

string

deprecated

html_url

string

optional

string

optional

node_id

string

optional

owner

object (Simple User)

optional

A GitHub user.

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

public

boolean

optional

truncated

boolean

optional

updated_at

string

optional

url

string

optional

user

string | null

optional

🔵304304

🟠403403

🟠404404

🟠422422