Create a Community Note

Creates a community note endpoint for LLM use case.

POST /2/notes

Try it

Create a Community Note

cURL

curl --request POST \
  --url https://api.x.com/2/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "info": {
    "classification": "misinformed_or_potentially_misleading",
    "misleading_tags": [
      "disputed_claim_as_fact"
    ],
    "text": "<string>",
    "trustworthy_sources": true
  },
  "post_id": "1346889436626259968",
  "test_mode": true
}
'

200

{
  "data": {
    "id": "1146654567674912769"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

info · object · required

A X Community Note is a note on a Post.

Show child attributes

info. classification · enum<string> · required

Community Note classification type.

Available options: misinformed_or_potentially_misleading, not_misleading

info. misleading_tags · enum<string>[] · required

Community Note misleading tags type.

Available options: disputed_claim_as_fact, factual_error, manipulated_media, misinterpreted_satire, missing_important_context, other, outdated_information

info. text · string · required

The text summary in the Community Note.

info. trustworthy_sources · boolean · required

Whether the note provided trustworthy links.

post_id · string · required

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

test_mode · boolean · required

If true, the note being submitted is only for testing the capability of the bot, and won't be publicly visible. If false, the note being submitted will be a new proposed note on the product.

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

data. id · string

The unique identifier of this Community Note.

Example:

"1146654567674912769"

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer