Docs menu
Docs Reference
Vercel AI SDK
Proxy tools for AI SDK agents: read pages from residential, datacenter or mobile IPs in the country the model picks.
Last verified: November 2026What it does
The proxmint-ai-sdk package gives an agent built on the Vercel AI SDK two tools. fetchPage reads one page through your proxy, from the country the model asks for, and returns the status, the final URL, the title and the page as readable text. getAccount reads the wallet balance and the bandwidth left on each product.
The tools call the hosted MCP server, which makes the request through your product and sends back the result, so they run anywhere fetch does: Node, edge functions and serverless. The proxy password never reaches the model. The package is on npm, the source on GitHub.
Install and connect
Install proxmint-ai-sdk next to ai and zod, and create an API key under Settings in the dashboard (the same read-only key the customer API uses):
Or pass { apiKey } to the tool. A key can't buy, pay or change settings.
Use it in an agent
Hand fetchPage() to generateText or streamText like any other tool. The model passes a URL and, when the task calls for it, a two-letter country:
For another product or a default location, pass options. proxmintTools() returns both tools with the same settings:
When a request fails, for example because the product is out of bandwidth or no IP matches the country, the result has ok: false, a one-line reason and what to change, so the model can retry or explain. The error codes page lists them all.
Options
| Option | Default | What it does |
|---|---|---|
apiKey | PROXMINT_API_KEY | The API key from Settings in the dashboard. |
product | "residential" | residential, premium-residential, datacenter or mobile. The account needs that product. |
country | dashboard targeting | Two-letter country code used when the model names none. |
Good to know
- Every call gets a new IP. Pages are cut at 50,000 characters and follow up to 5 redirects.
- Each fetch uses the bandwidth of the product it runs on, metered like any other request.
- A short list of sites is refused outright (see blocked websites), and the tool does not run JavaScript: it reads what the server sends.
- Need city targeting or one IP across calls? Use the proxy lines from the customer API with your own HTTP client.