---
title: "X/Twitter Inbox"
method: POST
path: "/api/tools/x_inbox"
tags: ["Social"]
---

# X/Twitter Inbox

`POST /api/tools/x_inbox`

## Request

- Base URL: `https://twitr.sh`
- URL: `https://twitr.sh/api/tools/x_inbox`
- Auth: none declared

Read a connected X/Twitter account's private surfaces: bookmarks and bookmark folders, notifications, and DM history. Billed per item returned; readable only for handles this wallet connected.

## Request body

- object
  - `action` 'bookmarks' | 'bookmark_folders' | 'notifications' | 'dm_history', required: Which inbox read to run.
  - `account` string, required: A connected X handle owned by this wallet (no @).
  - `resultsLimit` integer: Max items to return (billed per item); ignored for bookmark_folders.
  - `folderId` string: bookmarks: optional folder to read.
  - `type` string: notifications: optional filter (e.g. mentions).
  - `target_user_id` string: dm_history: the other party's user id.
  - `maxId` string: dm_history: paginate before this message id.

## Response `200`

Result dataset.

- object
  - `items` object[], required: Array of returned items. Shape varies per tool — see each tool's documentation.
  - `runId` string: Run ID for debugging/audit.
  - `duration` integer: Run duration in seconds.

## Other responses

- `202`: Async extraction accepted — body carries {snapshot_id, status_url} (x_extract only).
- `400`: Bad request — missing resultsLimit or Idempotency-Key where required. Body is a Problem with `retryable:false` and a `hint`; never charged.
- `402`: Payment Required. Per-result reads require x402 upto on Base: authorize the maximum and pay only for delivered records, with a $0.0024 non-empty minimum and zero for empty results. Fixed-price operations may additionally offer exact x402 and MPP.
- `403`: Acting handle not connected to this wallet — connect it via /api/x-accounts/start first; never charged.
- `404`: Unknown tool path — GET /openapi.json for the valid list; never charged.
- `429`: Rate limited — `retryable:true`; retry unchanged after the Retry-After header; never charged.
- `500`: Unexpected handler error — inspect payment receipt before retrying.
- `502`: Upstream provider error — `retryable:true`; inspect payment receipt before retrying; prepaid operations may already be charged.
- `503`: Service capacity temporarily unavailable — `retryable:true`; retry later; never charged.

---

[API](https://skmtc.dev/twitr/apis/twitr-sh.md) · [All operations](https://skmtc.dev/twitr/apis/twitr-sh/llms.txt) · [OpenAPI document](https://skmtc.dev/twitr/apis/twitr-sh/revisions/f6390fcee344?raw)