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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
X

X Community Notes API

Endpoints related to retrieving, searching, and modifying Community Notes — 5 operation(s) in the X-published contract.

Documentation Provider Profile APIs.io OpenAPI GitHub

X Community Notes API is one of 23 APIs that 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 and API documentation.

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

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

5 operations 5 paths 64 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.168
Base URL
https://api.x.com
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Contact
X Developers
License
X Developer Agreement and Policy
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

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 26 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

Endpoints related to retrieving, searching, and modifying Community Notes

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

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are Post (36 properties), User (28 properties), Media (13 properties), NotAuthorizedForFieldProblem (10 properties). Each schema is shown below with its type and property counts.

CreateCommunityNotesResponse
object
2 properties
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties 6 required
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
Media
object
13 properties
Note
object
5 properties
PostGeo
object
The location tagged on the Post, if the user provided one.
2 properties
FieldHydrationFailureProblem
object
7 properties 4 required
NoteInfo
object
Details about the Community Note's content, classification and source.
6 properties
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
NotAuthorizedForResourceProblem
object
9 properties 4 required
PostEntities
object
A list of metadata entities (hashtags, mentions, URLs) found in the Post text.
4 properties
MediaVariants
array
Each media object may have multiple display or playback variants, with different resolutions or formats.
DeleteCommunityNotesResponse
object
2 properties
PostReferencedPosts
array
A list of Posts this Post refers to. If the Post is a Retweet, Quote or Reply, it includes the referenced Post's type and ID.
EvaluateCommunityNotesRequest
object
2 properties 2 required
SearchEligiblePostsResponse
object
4 properties
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
SearchCommunityNotesWrittenResponse
object
3 properties
NotAuthorizedForFieldProblem
object
10 properties 4 required
CreateCommunityNotesResponseData
object
1 property 1 required
NoteTestResult
object
AI evaluation results for the Community Note (returned in test mode).
1 property
Post
object
36 properties
PostNoteRequestSuggestions
array
Community-Notes request suggestions for this Post.
PostNotePost
object
The full content of the Post, including text beyond 280 characters.
2 properties 1 required
Error
object
2 properties 2 required
InvalidRequestProblem
object
6 properties 3 required
EvaluateCommunityNotesResponseData
object
1 property
ResourceUnavailableProblem
object
6 properties 4 required
Poll
object
5 properties
UserWithheld
object
Withholding details for withheld content.
2 properties
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
NoteScoringStatus
object
Per-model scoring breakdown for the Community Note.
2 properties
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
PostMediaMetadata
array
Metadata for media attached to this Post.
PostScopes
object
The scopes for this Post.
1 property 1 required
NoteId
string
Unique identifier of a Note
DisallowedResourceProblem
object
7 properties 3 required
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
User
object
28 properties
PollOptions
array
The list of options (choices) available in this poll.
PostSuggestedSourceLinksWithCounts
array
Suggested source URLs for this Post, each with the number of times it was suggested.
DeleteCommunityNotesResponseData
object
1 property 1 required
CreateCommunityNotesInfo
object
5 properties 4 required
InternalErrorProblem
object
4 properties 3 required
EvaluateCommunityNotesResponse
object
2 properties
Topic
object
3 properties
UserPublicMetrics
object
A list of metrics for this User.
6 properties 4 required
PlaceGeo
object
The geographic location of this place, expressed as a GeoJSON Feature.
3 properties 3 required
CreateCommunityNotesRequest
object
3 properties 3 required
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
Place
object
8 properties
UserAffiliation
object
Metadata about a user's affiliation.
4 properties
Problem
PostWithheld
object
Withholding details for withheld content.
3 properties 2 required
MediaOrganicMetrics
object
Organic nonpublic engagement metrics for the media at the time of the request.
6 properties
ResourceNotFoundProblem
object
8 properties 4 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
PlaceContainedWithin
array
A list of unique identifiers of the Places that contain this place.
UserSubscription
object
The subscription relationship between this User and you.
1 property 1 required
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property 1 required
FieldUnauthorizedProblem
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs X publishes across the network.

X Account Activity API
AE Profile APIs.io
X Account API
AE Profile APIs.io
X Activity API
AE Profile APIs.io
X Articles API
AE Profile APIs.io
X Bots API
AE Profile APIs.io
X Broadcasts API
AE Profile APIs.io
X Chat API
AE Profile APIs.io
X Communities API
AE Profile APIs.io
X Compliance API
AE Profile APIs.io
X Connections API
AE Profile APIs.io
X Direct Messages API
AE Profile APIs.io
X General API
AE Profile APIs.io
#Community Notes
← Back to X APIs
API Details
ID
x:x-community-notes-api
Base URL
https://api.x.com
Docs
https://docs.x.com/x-api/community-notes/introduction
Provider
X
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=x-community-notes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/x-community-notes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of 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.