Use cases
Updated:
Each flow shows an example prompt and the tools the assistant calls, in order. You do not need to name tools — plain language is enough.
Check what is expiring
💬 “Which of my IPv4 proxies expire in the next 7 days? Show IP, country and expiry date.”
One call: list_proxies with type: "ipv4", ends: true.
Buy proxies
💬 “Buy 10 US IPv4 proxies for 1 month for Google, pay from the balance.”
get_reference — valid country and period codes.
calc_order_cost — price; the assistant shows it and asks for confirmation.
get_balance — enough funds?
make_order — after your confirmation.
check_order_status — until the proxies are issued.
export_proxies —
ip:portlines plus a note that passwords were left out; with your confirmation,reveal: truefor connectablelogin:password@host:portlines.
Get residential proxies for a location
💬 “Give me 5 residential proxies in Berlin, sticky IP, as login:password@host:port.”
get_resident_geo_count —
country: "DE",city: "Berlin"— are there nodes?add_resident_list —
ports: 5,rotation: -1,country: "DE",city: "Berlin"— the region the API needs (State of Berlin) is looked up automatically.export_proxies —
type: "resident",listId,ext: "%login%:%password%@%ip%:%port%"— the template asks for credentials, so the assistant confirms with you and passesreveal: true.
Without the confirmation step a template that names %password% is refused and the assistant asks you first; a plain export (no template) comes back as ip:port lines with a note that passwords were left out — that is the default, not a failure.
Analyse residential traffic
💬 “How much residential traffic did I use in August and what did it cost? Which list used the most?”
get_resident_consumption —
date_start: "2026-08-01",date_end: "2026-08-31".get_resident_package — what is left.
Give a teammate their own traffic
💬 “Create a subuser with 5 GB and a US list with 20 ports, rotation every 5 minutes.”
get_resident_package — enough traffic left?
create_resident_subpackage —
traffic_limit: 5368709120,is_link_date: true.add_resident_subuser_list —
country: "US",ports: 20,rotation: 300.export_proxies —
type: "subresident",package_key— anip:portlist; with your confirmation,reveal: truefor the credentials you hand over.
Pause them later:
💬 “Pause that subuser”
→ update_resident_subpackage with is_active: false.
Never let proxies expire
💬 “Turn on auto-renewal for all my ISP proxies from the balance, and top up $50 whenever the balance drops below $20.”
calc_autoprolong_cost — recurring amount and next charge date.
enable_autoprolong — after confirmation.
get_autotopup — is a card bound?
set_autotopup —
threshold: 20,amount: 50.
Both of these arm a recurring charge — see Payments & safety.
Fix a bad proxy
💬 “Proxy 185.x.x.x is not working, replace it.”
list_proxies — find it.
replace_proxy —
reason: "NOT_WORK".
Manage access
💬 “Whitelist my IP 1.1.1.1 for order 1234567”
One call: add_auth with ip, orderNumber.
💬 “Change the password of that login to …”
list_auth — find the authorization.
change_auth — send only what changes.
💬 “Move the whitelist of order 1234567 to 2.2.2.2”
→ list_auth → change_auth (ip).
💬 “Stop access from 1.1.1.1”
→ list_auth → delete_auth — an IP authorization cannot be disabled without a new IP.
Build an integration
💬 “How do I renew proxies through the API? Show a Node.js example.”
ps_docs_search — find the right page.
ps_api_get_endpoint — read the operation.
ps_sdk_snippet —
lang: "node".
Works with only docs:read — your account is never touched.