Skip to content

API reference

Read the account's muted words

x_read_muted_words — Words and phrases the account muted on X, with when each expires (null = forever).

x_read_muted_words · Live read on X (creates a job)

Words and phrases the account muted on X, with when each expires (null = forever). Counts as a sync read.

REST POST /api/public/v1/accounts/{account}/reads/muted-words
MCP tool x_read_muted_words
Permission needed accounts.run — Owner, Manager, Operator
Scope group x:read
Group Live reads on X
Shown up front in profiles Operate X accounts

Input

Field Type Required Description
account string (1–100 chars) Yes The X account to use: its X-Buddy account_id (from account_list) or its @handle. Ambiguous names return candidates instead of guessing.

Result

Creates a job for the X account's VPS. REST waits up to wait seconds (default 15, max 20): when done it returns 200 with the result, otherwise 202 with Location: /api/public/v1/jobs/{job_id}. The final status is succeeded, failed, cancelled or unknown.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/accounts/%40your_x_account/reads/muted-words" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "x_read_muted_words",
    "arguments": {
      "account": "@your_x_account"
    }
  }
}

Errors you may get

Back to all operations