How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Twitter/X Community Notes API

The Community Notes API from Twitter/X — 5 operation(s) for community notes.

Twitter/X Community Notes API is one of 22 APIs that Twitter/X publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Community Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 2.166.

Requests are made against a single base URL, https://api.x.com.

5 operations 5 paths 68 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.166
Base URL
https://api.x.com
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

Authentication & Security 3

Twitter/X Community Notes API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerToken). It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Community Notes 5
POST
/2/evaluate_note
Evaluate a Community Note
evaluateCommunityNotes body → 200default
POST
/2/notes
Create a Community Note
createCommunityNotes body → 200default
GET
/2/notes/search/notes_written
Search for Community Notes Written
searchCommunityNotesWritten 4 params → 200default
GET
/2/notes/search/posts_eligible_for_notes
Search for Posts Eligible for Community Notes
searchEligiblePosts 10 params → 200default
DELETE
/2/notes/{id}
Delete a Community Note
deleteCommunityNotes 1 param → 200default

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Tweet (32 properties), User (21 properties), UrlFields (9 properties), Place (8 properties). Each schema is shown below with its type and property counts.

MisleadingTags
string
Community Note misleading tags type.
Topic
object
The topic of a Space, as selected by its creator.
3 properties 2 required
Url
string
A validly formatted URL.
Place
object
8 properties 2 required
MediaKey
string
The Media Key identifier for this attachment.
NoteId
string
The unique identifier of this Community Note.
Media
object
4 properties 1 required
Note
object
A X Community Note is a note on a Post.
6 properties 3 required
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties 2 required
Tweet
object
32 properties
PollOption
object
Describes a choice in a Poll object.
3 properties 3 required
PollId
string
Unique identifier of this poll.
PlaceId
string
The identifier for this place.
ResultCount
integer
The number of results returned in this response.
CreateNoteRequest
object
3 properties 3 required
Error
object
2 properties 2 required
DeleteNoteResponse
object
2 properties
NoteRatingStatus
string
Community Note rating status
NoteScoringStatus
object
The scoring status of a Community Note.
2 properties
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties 1 required
MediaWidth
integer
The width of the media in pixels.
CommunityId
string
The unique identifier of this Community.
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Geo
object
4 properties 3 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties 1 required
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties 2 required
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
UrlImage
object
Represent the information for the URL image.
3 properties
PollOptionLabel
string
The text of a poll choice.
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties 2 required
NoteFactorBucketCounts
object
Rating counts for a rater factor bucket.
5 properties
EvaluateNoteResponse
object
2 properties
NextToken
string
The next token.
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties 1 required
TweetId
string
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.
Get2NotesSearchPostsEligibleForNotesResponse
object
4 properties
Get2NotesSearchNotesWrittenResponse
object
3 properties
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property 1 required
HashtagEntity
TweetText
string
The content of the Tweet.
NoteTestResult
object
The evaluation result of a community note.
2 properties
CashtagEntity
HttpStatusCode
integer
HTTP Status Code.
NoteTweetText
string
The note content of the Tweet.
MediaHeight
integer
The height of the media in pixels.
User
object
The X User object.
21 properties 3 required
NoteClassification
string
Community Note classification type.
NoteInfo
object
A X Community Note is a note on a Post.
5 properties 4 required
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties 2 required
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property 1 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties 2 required
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Poll
object
Represent a Poll attached to a Tweet.
5 properties 2 required
MentionEntity
CreateNoteResponse
object
2 properties
Expansions
object
6 properties
UserName
string
The X handle (screen name) of this user.
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
EvaluateNoteRequest
object
2 properties 2 required
FullTextEntities
object
5 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties 1 required
TopicId
string
Unique identifier of this Topic.
PlaceType
string
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties 1 required
NoteRatingCountsPerModel
object
The rating counts of a Community Note per model.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-x-community-notes-api-openapi.yml Raw ↑

Other APIs Twitter/X publishes across the network.

Twitter/X Account Activity API
Twitter/X Activity API
Twitter/X Articles API
Twitter/X Bookmarks API
Twitter/X Chat API
Twitter/X Communities API
Twitter/X Compliance API
Twitter/X Connections API
Twitter/X Direct Messages API
Twitter/X General API
Twitter/X Likes API
Twitter/X Lists API
Where this information came from

This is an independent, third-party profile of Twitter/X Community Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.