Skip to content

Commit bc6e9a8

Browse files
lanbytescursoragent
andcommitted
Expand Paperclip Mintlify docs with tools, routes, and credentials.
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 59391df commit bc6e9a8

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

changelog.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ title: "Changelog"
33
description: "Docs repository changes for the TwexAPI Mintlify site."
44
---
55

6+
## 2026-08-25
7+
8+
- Added Paperclip plugin docs with install, configuration, credentials, routes, and npm pin guidance.
9+
- Linked `@twexapi/paperclip-plugin-x-api-scraper` in the SDK index.
10+
611
## 2026-08-24
712

813
- First public docs repository aligned with the 66-operation SDK OpenAPI.

sdks/paperclip.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,27 @@ Install `@twexapi/paperclip-plugin-x-api-scraper` in Paperclip. The plugin reads
99
paperclipai plugin install @twexapi/paperclip-plugin-x-api-scraper
1010
```
1111

12+
Pin the current release when you need reproducible installs:
13+
14+
```bash
15+
paperclipai plugin install @twexapi/paperclip-plugin-x-api-scraper --version 0.1.0
16+
```
17+
18+
npm: [@twexapi/paperclip-plugin-x-api-scraper](https://www.npmjs.com/package/@twexapi/paperclip-plugin-x-api-scraper)
19+
20+
## Tools
21+
22+
| Agent task | Paperclip tool | Result |
23+
| --- | --- | --- |
24+
| Search tweets | `twexapi.search_tweets` | Run a Twitter search with query operators. |
25+
| Read one tweet | `twexapi.lookup_tweet` | Get a tweet by ID. |
26+
| Find X users | `twexapi.search_users` | Search by name or username. |
27+
| Read a profile | `twexapi.get_user` | Get public profile data. |
28+
| Read profile tweets | `twexapi.get_user_tweets` | List recent posts from one user. |
29+
| Read trending tweets | `twexapi.get_trends` | Get trending tweets by country. |
30+
31+
## TwexAPI routes
32+
1233
| Agent task | Paperclip tool | TwexAPI route |
1334
| --- | --- | --- |
1435
| Search tweets | `twexapi.search_tweets` | `POST /twitter/advanced_search/page` |
@@ -18,6 +39,25 @@ paperclipai plugin install @twexapi/paperclip-plugin-x-api-scraper
1839
| Read profile tweets | `twexapi.get_user_tweets` | `POST /twitter/{screen_name}/timeline/page` |
1940
| Read trending tweets | `twexapi.get_trends` | `GET /twitter/global-trending/tweets` |
2041

42+
## Configuration
43+
44+
- `apiBaseUrl`: TwexAPI REST endpoint. Defaults to `https://api.twexapi.io`.
45+
- `apiKeySecretRef`: Paperclip secret reference for the TwexAPI API key.
46+
- `defaultTimelineCount`: Default timeline page count from 1 to 100.
47+
- `defaultUserSearchCount`: Default user search count from 1 to 100.
48+
- `defaultTrendCount`: Default trend count from 1 to 100.
49+
50+
## Credentials
51+
52+
Create an API key in the [TwexAPI dashboard](https://twexapi.io/dashboard) and store it in a Paperclip secret referenced by `apiKeySecretRef`.
53+
2154
The plugin is read-only. Use REST or an SDK for follower pagination and approved posting.
2255

56+
## Resources
57+
58+
- [OpenAPI schema](https://docs.twexapi.io/openapi.json)
59+
- [API reference](/api-reference/overview)
60+
- [Paperclip plugin source](https://github.com/twexapi-dev/paperclip-plugin-x-api-scraper)
61+
- [TwexAPI dashboard](https://twexapi.io/dashboard)
62+
2363
Source: [paperclip-plugin-x-api-scraper](https://github.com/twexapi-dev/paperclip-plugin-x-api-scraper)

0 commit comments

Comments
 (0)