Create a content attachment - GitHub v3 REST API

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.

The app must create a content attachment within six hours of the content reference URL being posted. See "Using content attachments" for details about content attachments.

You must use an installation access token to access this endpoint.

curl --location --request POST 'https://api.github.com/content_references//attachments' \ --header 'Content-Type: application/json' \ --data-raw '{ "body": "Body of the attachment", "title": "Title of the attachment" }'

Request

Path Params

content_reference_id

integer

required

Body Params application/json

body

string

required

The body of the attachment

<= 262144 characters

Example:

Body of the attachment

title

string

required

The title of the attachment

<= 1024 characters

Example:

Title of the attachment

Examples

Responses

🟢200response

application/json

Body

Content Reference attachments allow you to provide context around URLs posted in comments

body

string

required

The body of the attachment

<= 262144 characters

Example:

Body of the attachment

integer

required

The ID of the attachment

Example:

node_id

string

optional

The node_id of the content attachment

Example:

MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=

title

string

required

The title of the attachment

<= 1024 characters

Example:

Title of the attachment

🔵304304

🟠403403

🟠404404

🟠410410

🟠415415

🟠422422