Skip to content
X-Buddy
Tiếng Việt

API reference

API reference

Every X-Buddy operation — MCP tool name, REST endpoint, kind, required permission, inputs, example and errors — generated from the live registry.

Markdown version

Each operation is one MCP tool and one REST endpoint. This list is generated from the same registry that serves MCP, REST and the OpenAPI document, so it is always current.

Kind Meaning
R Reads saved data, without creating a job on X.
L Live read on X. Creates a job on the X account's VPS.
X Write on X. Creates a job; needs an idempotency key.
W Changes an X-Buddy setting; needs an idempotency key.
D Deletes, or can't be undone; needs an idempotency key.

All 173 operations

Core: X accounts, jobs, tool search

MCP tool Description Kind REST
whoami Who am I R GET /me
account_list List X accounts R GET /accounts
account_get_status Account status R GET /accounts/{account}/status
job_get Get job R GET /jobs/{job_id}
job_list List jobs R GET /jobs
job_cancel Cancel job D POST /jobs/{job_id}/cancel
job_reconcile_get Reconciliation of an unknown job R GET /jobs/{job_id}/reconcile
job_reconcile_check Check an unknown job on X now W POST /jobs/{job_id}/reconcile/check
job_reconcile_conclude Conclude an unknown job W POST /jobs/{job_id}/reconcile

Live reads on X

MCP tool Description Kind REST
x_check_session Check X login L POST /accounts/{account}/reads/session
x_read_profile Read a profile on X L POST /accounts/{account}/reads/profile
x_read_connections Read followers / following L POST /accounts/{account}/reads/connections
x_search Search X L POST /accounts/{account}/reads/search
x_read_post_engagers Read who engaged with a post L POST /accounts/{account}/reads/post-engagers
x_read_list_timeline Read a List timeline L POST /accounts/{account}/reads/list
x_read_notifications Read notifications on X L POST /accounts/{account}/reads/notifications
x_sync_account Sync account data L POST /accounts/{account}/sync
x_sync_inbox Refresh inbox L POST /accounts/{account}/inbox/refresh
x_read_thread Read a post and its replies L POST /accounts/{account}/reads/thread
x_read_timeline Read the Home feed L POST /accounts/{account}/reads/timeline
x_read_relationship Read the relationship with a person L POST /accounts/{account}/reads/relationship
x_lookup Look up many posts or people L POST /accounts/{account}/reads/lookup
x_read_profile_tab Read a profile tab L POST /accounts/{account}/reads/profile-tab
x_read_suggestions Read follow suggestions L POST /accounts/{account}/reads/suggestions
x_read_explore Read Explore / trends L POST /accounts/{account}/reads/explore
x_read_capabilities Read what the account can use L POST /accounts/{account}/reads/capabilities
x_read_bookmarks Read the account's bookmarks L POST /accounts/{account}/reads/bookmarks
x_read_lists Read the account's Lists L POST /accounts/{account}/reads/lists
x_read_list_people Read a List's members or followers L POST /accounts/{account}/reads/list-people
x_read_native_drafts Read X's own drafts and scheduled posts L POST /accounts/{account}/reads/native-drafts
x_read_community Read a Community L POST /accounts/{account}/reads/community
x_read_settings Read the account's settings on X L POST /accounts/{account}/reads/settings
x_read_moderation_list Read the accounts blocked or muted L POST /accounts/{account}/reads/moderation-list
x_read_follow_requests Read pending follow requests L POST /accounts/{account}/reads/follow-requests
x_read_muted_words Read the account's muted words L POST /accounts/{account}/reads/muted-words

Synced X data

MCP tool Description Kind REST
account_get_profile_cached Account overview (saved) R GET /accounts/{account}
account_list_relations Saved followers / following R GET /accounts/{account}/relations
account_list_posts Saved posts of the account R GET /accounts/{account}/posts
account_list_notifications Saved notifications R GET /accounts/{account}/notifications
account_list_x_lists Lists owned by the account R GET /accounts/{account}/lists
chat_passcode_status X Chat passcode status R GET /accounts/{account}/chat
today_list Today list R GET /accounts/{account}/today

Actions on X

MCP tool Description Kind REST
post_set_like Like / unlike a post X POST /accounts/{account}/actions/like
post_bookmark Bookmark / remove a bookmark X POST /accounts/{account}/actions/bookmark
post_repost Repost a post X POST /accounts/{account}/actions/repost
post_reply Reply to a post X POST /accounts/{account}/actions/reply
post_quote Quote a post X POST /accounts/{account}/actions/quote
user_set_follow Follow / unfollow X POST /accounts/{account}/actions/follow
user_set_mute Mute / unmute a person X POST /accounts/{account}/actions/mute
user_set_block Block / unblock a person X POST /accounts/{account}/actions/block
user_set_reposts Show / hide a person's reposts X POST /accounts/{account}/actions/reposts-visibility
user_set_notify Turn a person's post bell on / off X POST /accounts/{account}/actions/notify
follower_remove Remove a follower X POST /accounts/{account}/actions/remove-follower
post_set_pin Pin / unpin an own post X POST /accounts/{account}/actions/pin
poll_vote Vote in a poll X POST /accounts/{account}/actions/poll-vote
dm_send Send a direct message X POST /accounts/{account}/actions/dm
dm_share_post Share a post in a DM X POST /accounts/{account}/actions/share-post
post_publish Publish a post now X POST /accounts/{account}/actions/post
post_delete_on_x Delete a post on X X POST /accounts/{account}/actions/delete-post
x_list_create Create an X List X POST /accounts/{account}/lists
x_list_delete Delete an X List X DELETE /accounts/{account}/lists/{list_id}
x_list_set_member Add / remove a List member X POST /accounts/{account}/lists/{list_id}/members
community_join Join a Community X POST /accounts/{account}/actions/community-join
x_browse_session Browse session X POST /accounts/{account}/actions/browse
x_profile_update Edit the X profile X POST /accounts/{account}/actions/profile
chat_unlock Unlock X Chat X POST /accounts/{account}/actions/chat-unlock
conversation_set_mute Mute / unmute a conversation X POST /accounts/{account}/actions/conversation-mute
conversation_leave Leave a conversation X POST /accounts/{account}/actions/conversation-leave
reply_set_hidden Hide / unhide a reply X POST /accounts/{account}/actions/reply-hidden
post_set_reply_policy Change who can reply X POST /accounts/{account}/actions/reply-policy
list_set_subscription Follow / unfollow a List X POST /accounts/{account}/actions/list-subscription
list_set_pin Pin / unpin a List X POST /accounts/{account}/actions/list-pin
list_update Edit a List X POST /accounts/{account}/actions/list-update
bookmarks_clear Clear all bookmarks X POST /accounts/{account}/actions/bookmarks-clear
community_leave Leave a Community X POST /accounts/{account}/actions/community-leave
native_draft_delete Delete an X draft / scheduled post X POST /accounts/{account}/actions/native-draft-delete
dm_conversation_set_state Set a conversation's state in X Chat X POST /accounts/{account}/actions/conversation-state
dm_conversation_delete Delete a conversation from the X Chat inbox X POST /accounts/{account}/actions/conversation-delete
dm_request_resolve Accept or delete a message request X POST /accounts/{account}/actions/message-request
follow_request_decide Accept or decline a follow request X POST /accounts/{account}/actions/follow-request
muted_word_set Mute or unmute a word X POST /accounts/{account}/actions/muted-word
x_settings_set Change the account's settings on X X POST /accounts/{account}/actions/settings
x_batch Run one X action over many items X POST /batches
x_batch_get Get a batch R GET /batches/{batch_id}
x_batch_cancel Cancel the rest of a batch W POST /batches/{batch_id}/cancel

Tasks and playbooks

MCP tool Description Kind REST
task_list List automation tasks R GET /tasks
task_get Get one task R GET /tasks/{task_id}
task_set_enabled Switch a task on / off W POST /tasks/{task_id}/enabled
playbook_list List playbooks R GET /playbooks
playbook_apply Apply a playbook to accounts W POST /playbooks/{playbook_id}/apply
playbook_get Get a playbook R GET /playbooks/{playbook_id}
playbook_save Create or edit a playbook W POST /playbooks
playbook_delete Delete a playbook D DELETE /playbooks/{playbook_id}
playbook_apply_bulk Apply a playbook to many accounts W POST /bulk/playbook-apply
task_save Create or edit one account task W POST /tasks
task_delete Delete one account task D DELETE /tasks/{task_id}
task_bulk_patch Change matching tasks on many accounts W POST /bulk/tasks

Campaigns

MCP tool Description Kind REST
campaign_list List campaigns R GET /campaigns
campaign_get Get a campaign R GET /campaigns/{campaign_id}
campaign_list_people People in a campaign R GET /campaigns/{campaign_id}/people
campaign_set_status Start / pause / stop a campaign W POST /campaigns/{campaign_id}/status
template_list List message templates R GET /templates
template_get Get a message template R GET /templates/{template_id}
template_save Create or edit a message template W POST /templates
template_delete Delete a message template D DELETE /templates/{template_id}
template_render Preview a template for one person R POST /templates/render
campaign_enroll_people Add people to a campaign W POST /campaigns/{campaign_id}/people

Posts

MCP tool Description Kind REST
post_list_scheduled List scheduled posts R GET /posts
post_get Get a scheduled post R GET /posts/{post_id}
post_schedule Schedule a post W POST /posts
post_cancel Cancel a scheduled post W POST /posts/{post_id}/cancel
media_create_upload Create a media upload W POST /media/uploads

Contacts and lists

MCP tool Description Kind REST
people_search Search people R GET /people
people_get Get a person R GET /people/{person}
lead_list_list List lead lists R GET /lead-lists
lead_add_people Add people to a lead list W POST /lead-lists/{list_id}/people
people_update Update a person's note / tags W PATCH /people/{person}
suppression_list Do-not-contact list R GET /suppressions
suppression_add Add to do-not-contact W POST /suppressions
suppression_remove Remove from do-not-contact D DELETE /suppressions/{suppression_id}
account_relations_export Export an account's followers / following R GET /accounts/{account}/relations/export

Growth

MCP tool Description Kind REST
competitor_list List watched competitors R GET /competitors
today_mark Mark Today items W POST /accounts/{account}/today/marks

Inbox

MCP tool Description Kind REST
inbox_list_threads List conversations R GET /threads
inbox_get_messages Read a conversation R GET /threads/{thread_id}/messages
inbox_update_thread Update a conversation W PATCH /threads/{thread_id}

Reports

MCP tool Description Kind REST
activity_list Activity log R GET /activity
stats_actions_daily Actions per day R GET /stats/actions
stats_follower_changes Follower changes R GET /stats/followers
stats_dm_replies DM reply rate R GET /stats/dm
usage_get This connection's usage R GET /usage

VPS, proxies and alerts

MCP tool Description Kind REST
vps_list List VPS machines R GET /vps
proxy_list List proxies R GET /proxies
alerts_list List alerts R GET /alerts
account_set_paused Pause / resume an account W POST /accounts/{account}/paused
members_list List workspace members R GET /members
account_bulk_set_paused Pause / resume many accounts W POST /bulk/accounts/paused
alerts_refresh Re-check alerts now R POST /alerts/refresh
telegram_status Telegram alert channel status R GET /telegram
telegram_test Send a Telegram test message W POST /telegram/test
telegram_discover_chat Find chats that wrote to the bot R POST /telegram/discover-chat
announcements_list List X-Buddy announcements R GET /announcements
limits_baseline_get Which base limits the workspace inherits R GET /limits/baseline

X account groups

MCP tool Description Kind REST
account_group_list List account groups R GET /groups
account_group_get Get an account group R GET /groups/{group_id}
account_group_save Create or rename an account group W POST /groups
account_group_delete Delete an account group D DELETE /groups/{group_id}
account_group_set_members Add / remove accounts of a group W POST /groups/{group_id}/members

Configuration and limits

MCP tool Description Kind REST
post_settings_get Get post settings R GET /settings/posts
post_settings_save Save post settings W PUT /settings/posts
lead_settings_get Get customer-list settings R GET /settings/leads
lead_settings_save Save customer-list settings W PUT /settings/leads
growth_settings_get Get growth settings R GET /settings/growth
growth_settings_save Save growth settings W PUT /settings/growth
config_export Export the workspace configuration R GET /config/export
config_validate Check a configuration file R POST /config/validate
config_plan Plan applying a configuration file R POST /config/plan
config_apply Apply a configuration plan W POST /config/apply

Events and webhooks

MCP tool Description Kind REST
events_list List events R GET /events
webhook_list List webhook endpoints R GET /webhooks
webhook_get Get a webhook endpoint R GET /webhooks/{endpoint_id}
webhook_save Create or change a webhook endpoint W POST /webhooks
webhook_set_active Pause or resume a webhook endpoint W POST /webhooks/{endpoint_id}/active
webhook_rotate_secret Rotate a webhook secret W POST /webhooks/{endpoint_id}/rotate-secret
webhook_test Send a test webhook W POST /webhooks/{endpoint_id}/test
webhook_redeliver Send a delivery again W POST /webhook-deliveries/{delivery_id}/redeliver
webhook_delete Delete a webhook endpoint D DELETE /webhooks/{endpoint_id}

Indirect calls and docs

MCP tool Description Kind REST
tools_search Find operations R GET /operations/search
tools_describe Describe operations R GET /operations/describe
execute_read Run a read operation R POST /operations/read
execute_write Run a write operation W POST /operations/write
docs_search Search the X-Buddy docs R GET /docs/search
docs_read Read an X-Buddy docs page R GET /docs/page