CommunityNotesClient

Reference for the CommunityNotesClient class in the X API TypeScript SDK. Methods, parameters, and return types for the X API v2 community notes endpoints.

Client for community notes operations

This client provides methods for interacting with the community notes endpoints of the X API. It handles authentication, request formatting, and response parsing for all community notes related operations.

Constructors

constructor

• new CommunityNotesClient(client): CommunityNotesClient

Creates a new community notes client instance

Parameters

Name	Type	Description
client	Client	The main X API client instance

Returns

CommunityNotesClient

Defined in

community_notes/client.ts:186

Methods

searchEligiblePosts

▸ searchEligiblePosts(testMode, options): Promise<Response>

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

Parameters

Name	Type	Description
testMode	boolean	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.
options	SearchEligiblePostsOptions & { requestOptions: { raw: true } }	-

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

community_notes/client.ts:231

▸ searchEligiblePosts(testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>

Parameters

Name	Type
testMode	boolean
options?	SearchEligiblePostsOptions

Returns

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

Defined in

community_notes/client.ts:244

---

evaluate

▸ evaluate(options): Promise<Response>

Evaluate a Community Note Endpoint to evaluate a community note.

Parameters

Name	Type
options	EvaluateOptions & { requestOptions: { raw: true } }

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

community_notes/client.ts:535

▸ evaluate(options?): Promise<EvaluateNoteResponse>

Parameters

Name	Type
options?	EvaluateOptions

Returns

Promise<EvaluateNoteResponse>

Defined in

community_notes/client.ts:544

---

searchWritten

▸ searchWritten(testMode, options): Promise<Response>

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

Parameters

Name	Type	Description
testMode	boolean	If true, return the notes the caller wrote for the test. If false, return the notes the caller wrote on the product.
options	SearchWrittenOptions & { requestOptions: { raw: true } }	-

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

community_notes/client.ts:640

▸ searchWritten(testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>

Parameters

Name	Type
testMode	boolean
options?	SearchWrittenOptions

Returns

Promise<Get2NotesSearchNotesWrittenResponse>

Defined in

community_notes/client.ts:653

---

delete

▸ delete(id, options): Promise<Response>

Delete a Community Note Deletes a community note.

Parameters

Name	Type	Description
id	string	The community note id to delete.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

community_notes/client.ts:826

▸ delete(id): Promise<DeleteNoteResponse>

Parameters

Name	Type
id	string

Returns

Promise<DeleteNoteResponse>

Defined in

community_notes/client.ts:839

---

create

▸ create(options): Promise<Response>

Create a Community Note Creates a community note endpoint for LLM use case.

Parameters

Name	Type
options	CreateOptions & { requestOptions: { raw: true } }

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

community_notes/client.ts:926

▸ create(options?): Promise<CreateNoteResponse>

Parameters

Name	Type
options?	CreateOptions

Returns

Promise<CreateNoteResponse>

Defined in

community_notes/client.ts:935