Constructors
constructor
• new CommunityNotesClient(client): CommunityNotesClient
Creates a new community notes client instance
Parameters
Returns
CommunityNotesClient
Defined in
community_notes/client.ts:186Methods
searchEligiblePosts
▸ searchEligiblePosts(testMode, options): Promise<Response>
Search for Posts Eligible for Community Notes
Returns all the posts that are eligible for community notes.
Parameters
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
Returns
Promise<Get2NotesSearchPostsEligibleForNotesResponse>
Defined in
community_notes/client.ts:244evaluate
▸ evaluate(options): Promise<Response>
Evaluate a Community Note
Endpoint to evaluate a community note.
Parameters
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
Returns
Promise<EvaluateNoteResponse>
Defined in
community_notes/client.ts:544searchWritten
▸ searchWritten(testMode, options): Promise<Response>
Search for Community Notes Written
Returns all the community notes written by the user.
Parameters
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
Returns
Promise<Get2NotesSearchNotesWrittenResponse>
Defined in
community_notes/client.ts:653delete
▸ delete(id, options): Promise<Response>
Delete a Community Note
Deletes a community note.
Parameters
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
Returns
Promise<DeleteNoteResponse>
Defined in
community_notes/client.ts:839create
▸ create(options): Promise<Response>
Create a Community Note
Creates a community note endpoint for LLM use case.
Parameters
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
Returns
Promise<CreateNoteResponse>