−25%

on annual Windows plans, until 31 Oct. See plans

EQVPS
Get started

Connecting your account

You already have an EQVPS account and want a script or an agent to use it: get a token, put it into the config, start the first sandbox and keep the balance topped up.

How it fits together

Your accounteqvps.comAPI tokenBearer …Agent or scriptMCP · REST · SDKEQVPS APIapi.eqvps.comSandboxPython · Node · bashBalanceUSD$ / s
The token says who you are. Every request runs on your account, and sandbox time is charged to your balance.

1. Get a token

The easiest way: in the dashboard open Settings → API tokens, create a token (name it after the agent, pick an expiry) and copy it. It is shown only once.

From the command line: log in with email and password to get a fresh token. If you signed up with an email code and never set a password, set one once using a token from the dashboard. You can also create a new account with POST /auth/register, which returns a token straight away.

# log in with email + password → token
curl -s https://api.eqvps.com/api/v1/eqvps/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your-password"}'
# → {"token":"eyJ0…","token_type":"Bearer","token_expires_at":"2027-10-03T…","user":{…}}

# signed up with an email code and have no password? set one once
# (authorise with a token from Settings → API tokens)
curl -s https://api.eqvps.com/api/v1/eqvps/auth/set-password \
  -H "Authorization: Bearer $EQVPS_API_KEY" -H "Content-Type: application/json" \
  -d '{"password":"new-pass-123","password_confirmation":"new-pass-123"}'

# no account yet: register straight from the API (password is optional)
curl -s https://api.eqvps.com/api/v1/eqvps/auth/register \
  -H "Content-Type: application/json" -d '{"email":"you@example.com"}'

# extend a token before it expires
curl -s -X POST https://api.eqvps.com/api/v1/eqvps/auth/token/refresh \
  -H "Authorization: Bearer $EQVPS_API_KEY"

A token is valid for 1 year (see token_expires_at in the response). Extend it with POST /auth/token/refresh; revoke the ones you no longer use in Settings.

2. Put it into the config

Keep the token out of your code: export it as EQVPS_API_KEY. MCP clients get it in the Authorization header.

# shell / CI secret — keep it out of the code
export EQVPS_API_KEY="eyJ0…"

# SDKs read the same variable (0.2.0+: give your code its secrets as env, not in the source)
pip install -U eqvps         # Python
npm i @eqvps/sdk@latest      # TypeScript / JavaScript

# Claude Code
claude mcp add --transport http eqvps https://mcp.eqvps.com/mcp \
  --header "Authorization: Bearer $EQVPS_API_KEY"

# Cursor, Claude Desktop, other MCP clients (mcp.json)
{
  "mcpServers": {
    "eqvps": {
      "type": "streamable-http",
      "url": "https://mcp.eqvps.com/mcp",
      "headers": { "Authorization": "Bearer <YOUR_TOKEN>" }
    }
  }
}

3. Start the first sandbox

Create, run code, delete. A non-zero exit_code is a normal result of your command, not an HTTP error.

API=https://api.eqvps.com/api/v1/eqvps
H="Authorization: Bearer $EQVPS_API_KEY"

SB=$(curl -s -X POST $API/sandboxes -H "$H" -H "Content-Type: application/json" \
  -d '{"tariff":"micro"}' | python3 -c 'import sys,json; print(json.load(sys.stdin)["id"])')

curl -s -X POST $API/sandboxes/$SB/run -H "$H" -H "Content-Type: application/json" \
  -d '{"language":"bash","code":"uname -sr && python3 --version && node --version"}'
# → {"exit_code":0,"stdout":"Linux 6.1…\nPython 3.12…\nv22…\n","stderr":"",…}

curl -s -X DELETE $API/sandboxes/$SB -H "$H"

Modes, tariffs and Python / Node.js examples: Sandboxes →

4. Top up the balance

Sandboxes and servers are paid from one prepaid balance. Top it up in the dashboard (Balance: crypto, Monero or a promo code) or with POST /balance/topup, which returns a payment link. GET /balance shows how much is left.

curl -s $API/balance -H "$H"
# → {"balance":12.4,"currency":"USD","promo_balance":0,"real_balance":12.4,"promo_scope":"sandboxes"}

curl -s -X POST $API/balance/topup -H "$H" -H "Content-Type: application/json" -d '{"amount":10}'
# → {"invoice_id":…,"checkout_url":"https://…"}   open the link and pay with crypto

Errors you are likely to see

  • 401 Unauthenticated — the token is missing, mistyped, expired or revoked. Check the Authorization: Bearer header, create a new token in Settings or log in again.
  • 402 insufficient_balance — the balance is empty, so a new sandbox cannot start. Top up and repeat the request. Running persistent sandboxes are paused rather than deleted.
  • 429 and 503 mean the request was turned away before anything ran: wait for Retry-After and send it again. 409 sandbox_paused: top up and the sandbox resumes.
HTTP 401  {"message":"Unauthenticated."}
HTTP 402  {"error":"insufficient_balance","message":"Your balance cannot cover this sandbox. Top up (topup_balance / POST /balance/topup) and retry."}
HTTP 429  {"error":"too_many_concurrent", …}      → wait Retry-After, then retry
HTTP 503  {"error":"capacity","retry_after":30, …} → wait Retry-After, then retry

Comments

No comments yet. Be the first.

Leave a comment

Comments are moderated before they appear.