Tg Auto Status

Poll a running QR session. Read-only — never advances the state machine. Tenant-scoped: 404 if the session isn’t owned by this project.

GET /boxes/me/tg/auto/{qr_session_id}

Tg Auto Status

JavaScript

const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v3/boxes/me/tg/auto/{qr_session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.browser-use.com/api/v3/boxes/me/tg/auto/{qr_session_id} \
  --header 'X-Browser-Use-API-Key: <api-key>'

import requests

url = "https://api.browser-use.com/api/v3/boxes/me/tg/auto/{qr_session_id}"

headers = {"X-Browser-Use-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "live_url": "<string>",
  "bot_username": "<string>",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-Browser-Use-API-Key · string · header · required

Path Parameters

qr_session_id · string<uuid> · required

Response

200

application/json

Successful Response

Snapshot of a QR onboarding session. Returned by start, status, and cancel — same shape so the FE renders a single view component.

id · string<uuid> · required

state · enum<string> · required

Available options: pending_browser, waiting_scan, login_detected, minting, installing, installed, failed, expired

live_url · string | null · required

bot_username · string | null · required

error_code · enum<string> | null · required

Available options: bu_cloud_auth, bu_cloud_unavailable, bu_cloud_rate_limited, bu_cloud_timeout, scan_timeout, agent_dispatch_failed, agent_timeout, agent_no_output, agent_failed, invalid_token, bot_username_collision, rate_limited_botfather, box_not_ready, tg_already_installed, install_telegram_failed, box_offline, cancelled, concurrent_limit, internal

error_message · string | null · required

created_at · string<date-time> · required

updated_at · string<date-time> · required