API reference

The local OpenAPI provides 74 endpoints covering service status, users and teams, accounts, proxies, browser windows, window groups, automation sessions, and the Proxy Store, cloud phone numbers, mailbox service, CAPTCHA solving, and billing transactions. Each group has its own page; the overview below searches every endpoint and links straight to its details.

For the action names and fields that automation accepts, see the automation action allowlist.

Search all endpoints

Showing 74 of 74 endpoints

Basics & User3 endpoints

• GET/healthService health status
• GET/user/infoCurrent user info
• POST/user/configEcho user config

Teams5 endpoints

• GET/team/listList teams
• POST/team/inviteInvite team member
• POST/team/batch_inviteBatch invite team members
• POST/team/modifyCreate or update team
• POST/team/deleteDelete teams

Platform Accounts5 endpoints

• GET/account/listList platform accounts
• POST/account/createCreate platform account
• POST/account/batch_createBatch create platform accounts
• POST/account/modifyUpdate platform account
• POST/account/deleteDelete platform accounts

Proxies10 endpoints

• GET/proxy/listList proxies
• GET/proxy/list_mergedList merged proxies
• GET/proxy/bought_listList purchased proxies
• GET/proxy/detailGet proxy details
• POST/proxy/createCreate proxy
• POST/proxy/batch_createBatch create proxies
• POST/proxy/importImport proxies
• POST/proxy/detectCheck proxy
• POST/proxy/modifyUpdate proxy
• POST/proxy/deleteDelete proxy

Browser Windows10 endpoints

• GET/browser/listList windows
• POST/browser/createCreate browser window
• POST/browser/proxyBind or unbind window proxy
• POST/browser/accountBind or unbind window platform accounts
• POST/browser/groupMove windows to group
• POST/browser/nameRename window
• GET/browser/accountsList fillable accounts for windows
• POST/browser/openOpen browser window
• GET/browser/connection_infoBrowser connection info
• POST/browser/closeClose browser window

Window Groups4 endpoints

• GET/group/listList window groups
• POST/group/createCreate window group
• POST/group/modifyRename or reorder window group
• POST/group/deleteDelete window group

Automation Sessions11 endpoints

• POST/automation/sessionsCreate automation session
• DELETE/automation/sessionsClose all client sessions
• GET/automation/sessions/:sessionIdGet automation session
• DELETE/automation/sessions/:sessionIdClose automation session
• GET/automation/sessions/:sessionId/tabsList tabs
• POST/automation/sessions/:sessionId/tabsOpen new tab
• POST/automation/sessions/:sessionId/tabs/selectSelect active tab
• POST/automation/sessions/:sessionId/tabs/closeClose tab
• POST/automation/sessions/:sessionId/account_candidatesList account candidates
• POST/automation/sessions/:sessionId/account_fillFill window login account
• POST/automation/sessions/:sessionId/actionsRun automation action

Proxy Store8 endpoints

• GET/ip/productsList proxy products
• POST/ip/buyBuy proxies
• GET/ip/ordersList proxy orders
• POST/ip/renewRenew proxies
• GET/ip/snap/plansList short-term proxy plans
• GET/ip/snap/productsList short-term proxy countries
• POST/ip/snap/buyBuy short-term proxy quota
• POST/ip/snap/pullPull short-term proxies

Cloud Phone Numbers6 endpoints

• GET/sms/countriesList number countries
• GET/sms/stocksNumber projects and stock
• POST/sms/buyBuy phone numbers
• GET/sms/recordsPurchased number records
• POST/sms/pullRead number SMS
• POST/sms/recoverRelease number and request refund

Mailbox Service6 endpoints

• GET/mail/plansMailbox plans
• GET/mail/domainsTemporary mailbox domains
• POST/mail/buyBuy mailbox
• GET/mail/recordsPurchased mailbox records
• POST/mail/pullSync and list emails
• POST/mail/detailEmail details

CAPTCHA Solving5 endpoints

• GET/captcha/productsList solving products
• POST/captcha/schemaGet product parameter model
• POST/captcha/buySubmit solving task
• GET/captcha/recordsSolving task records
• POST/captcha/queryGet solving result

Billing Transactions1 endpoints

• GET/billing/tradesList billing transactions