Accounts

Start connecting an X account — returns a link for the user (free, SIWX)

THE way an agent connects an account: send only {username} and receive a single-use connect_url (15-minute TTL). Show that link to the user — they open it in their own browser and sign in to X there, so no password, email, or 2FA secret ever passes through the agent. Then poll GET /api/x-accounts until the handle reads linked. This endpoint refuses any request containing credentials.

post/api/x-accounts/start

Request

  • Base URL: https://twitr.sh
  • URL: https://twitr.sh/api/x-accounts/start
  • Auth: API key in header SIGN-IN-WITH-X

Request body

usernamestring required

The X handle to connect, without @.

Response

{handle, connect_url, expires_in} — give connect_url to the user.

Changes

No recorded changes to this operation across all 1 revision of this API.