Overview
Articles: Create, edit, publish, and read X's long-form Articles (X's internal name: Notes). Publishing posts a real announcement tweet; reading a published article is a public call that needs no session.
Create, edit, publish, and read X's long-form Articles (X's internal name: Notes). Publishing posts a real announcement tweet; reading a published article is a public call that needs no session.
This category has 9 endpoints. Each is a pay-per-call REST endpoint with bearer auth, JSON in and out.
| Method | Path | Cost | Description |
|---|---|---|---|
POST | /article/create | $0.0016 | Start a new draft article. No request body required. |
POST | /article/update_title | $0.0016 | Set the title on a draft or published article. |
POST | /article/update_cover_media | $0.0016 | Attach an uploaded image as an article's cover. |
POST | /article/update_content | $0.0016 | Replace an article's body with a new Draft.js content_state. |
POST | /article/publish | $0.0016 | Publish a draft article. This posts a real, public announcement tweet. |
POST | /article/unpublish | $0.0016 | Revert a published article back to Draft. The announcement tweet is left in place. |
GET | /article/get | $0.0008 | Read an article via its announcement tweet, or your own via its entity id. |
GET | /article/list | $0.0008 | List your own articles, filtered by lifecycle (draft or published). |
POST | /article/delete | $0.0008 | Delete an article. A draft is hard-deleted; a published article is unpublished, then its announcement tweet is removed too. |
Create Article
Start a new draft article. No request body required.
Update Article Title
Set the title on a draft or published article.
Update Article Cover Image
Attach an uploaded image as an article's cover.
Update Article Content
Replace an article's body with a new Draft.js content_state.
Publish Article
Publish a draft article. This posts a real, public announcement tweet.
Unpublish Article
Revert a published article back to Draft. The announcement tweet is left in place.
Get Article
Read an article via its announcement tweet, or your own via its entity id.
List Articles
List your own articles, filtered by lifecycle (draft or published).
Delete Article
Delete an article. A draft is hard-deleted; a published article is unpublished, then its announcement tweet is removed too.
Payment History GET
Returns the payment history for the account behind your API key, ordered newest first. Each entry records what was paid, how many credits it added, and whether the payment completed. Use it to reconcile top-ups against your own billing records. This call is free. Cost: Free per call.
Create Article POST
Start a new draft Article as the account behind your registered session, and return its entity id, ready for Update Title / Update Content. The draft is empty until you call those. Requires a registered session. Billed at $0.0016 per call. Cost: $0.0016 per call.