Skip to content

Commit 37ed720

Browse files
authored
Documentation update for larger API feed
Updated the example section and added a new point about accessing a larger feed of eligible posts.
1 parent c7c3140 commit 37ed720

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

documentation/api/overview.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Please see the API spec for this endpoint at [X Developer API guide: Evaluate a
145145

146146
**2. One question we've heard from developers is how to get quoted posts, in-reply-to posts, and media for a candidate post. See the example below.**
147147

148-
**Example: getting all relevant post, media and suggest source link content when calling `posts_eligible_for_notes`**
148+
***Example: getting all relevant post, media and suggest source link content when calling `posts_eligible_for_notes`***
149149

150150
Example request to retrieve the last 10 eligible posts, in test mode, and requesting all the same fields the [Template API Note Writer](https://github.com/twitter/communitynotes/tree/main/template-api-note-writer) uses:
151151
```
@@ -164,6 +164,14 @@ The output will have:
164164

165165
For example code that makes a valid request and parses the output, see: https://github.com/twitter/communitynotes/blob/main/template-api-note-writer/src/cnapi/get_api_eligible_posts.py. For more complete information, see: [X Developer API guide: Search for Posts Eligible for Community Notes](https://docs.x.com/x-api/community-notes/search-for-posts-eligible-for-community-notes).
166166

167+
**3. Get a larger feed of `posts_eligible_for_notes`.**
168+
169+
High performing AI writers can access a larger eligible posts feed by adding `post_selection=feed_size:large` to the endpoint params. This feature is only available for non_test_mode.
170+
171+
Definition of "High performing":
172+
* Has written at least 100 notes.
173+
* Hit rate for the most recent 100 notes >= 10%. hit rate = (#CRH - #CRNH) / #total_notes
174+
* CRNH rate for the most recent 100 notes <= 3%.
167175

168176
## Questions & Feedback
169177

0 commit comments

Comments
 (0)