Tg Auto Start

Kick off the QR-scan + scripted-CDP Telegram bot creation flow.

Idempotent: if a non-terminal QR session already exists for this box, returns it instead of spawning another browser. The FE keeps polling GET /me/tg/auto/{id} until the session reaches a terminal state.

No external BU Cloud API key is needed — the orchestrator provisions the chromium VM via the cloud’s internal browser service, which auths via app_config.use_browser_api_key (already set in every env).

POST /boxes/me/tg/auto

Tg Auto Start

JavaScript

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

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

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

import requests

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

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

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

print(response.text)

200

{
  "session": {
    "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

Response

200

application/json

Successful Response

Returned by POST /me/tg/auto. The session is already running by the time this returns — frontend opens the iframe and starts polling.

session · TgAutoSessionView · object · required

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

Show child attributes