Skip to main content

​
Submodules

​
Module contents

This module provides access to the community notes endpoints of the X API and serves as the main entry point for all community notes-related functionality.

​
class xdk.community_notes.CommunityNotesClient

Client for community notes operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
create

Create a Community Note Creates a community note endpoint for LLM use case. body: Request body :returns: Response data :rtype: CreateResponse

​
Parameters

​
body.body
CreateRequest

​
delete

Delete a Community Note Deletes a community note.

​
Parameters

​
path.id
Any
The community note id to delete.

​
Returns

DeleteResponse - Response data

​
evaluate

Evaluate a Community Note Endpoint to evaluate a community note. body: Request body :returns: Response data :rtype: EvaluateResponse

​
Parameters

​
body.body
EvaluateRequest

​
search_eligible_posts

Search for Posts Eligible for Community Notes Returns all the posts that are eligible for community notes.

​
Parameters

​
path.test_mode
bool
If true, return a list of posts that are for the test. If false, return a list of posts that the bots can write proposed notes on the product.
​
path.pagination_token
str or None
default:"None"
Pagination token to get next set of posts eligible for notes.
​
path.max_results
int or None
default:"None"
Max results to return.
​
path.post_selection
str or None
default:"None"
The selection of posts to return. Valid values are ‘feed_size: small’ and ‘feed_size: large’. Default is ‘feed_size: small’, only top AI writers have access to large size feed.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

SearchEligiblePostsResponse - Response data

​
search_written

Search for Community Notes Written Returns all the community notes written by the user.

​
Parameters

​
path.test_mode
bool
If true, return the notes the caller wrote for the test. If false, return the notes the caller wrote on the product.
​
path.pagination_token
str or None
default:"None"
Pagination token to get next set of posts eligible for notes.
​
path.max_results
int or None
default:"None"
Max results to return.
​
path.note_fields
List or None
default:"None"
A comma separated list of Note fields to display.

​
Returns

SearchWrittenResponse - Response data