KeyRoute Documentation

KeyRoute provides ephemeral WireGuard VPN tunnels for AI agents and automated systems. Unlike HTTP proxies, KeyRoute gives you a full network tunnel - all TCP and UDP traffic from your application routes through our servers.

Each tunnel gets a unique IP address on our subnet (10.100.0.0/16) and routes all traffic through the selected region's public IP. Tunnels are ephemeral - they auto-expire after your specified duration, and you only pay for the seconds used.

KeyRoute is perfect for scenarios where you need to route all traffic from a specific geographic location - web scraping, testing geo-restricted services, or accessing region-locked APIs.

All API requests require a Bearer token from KeyKeeper. Include your token in the Authorization header:

Authorization: Bearer YOUR_KEYKEEPER_TOKEN

Create a tunnel by POSTing to /v1/tunnel with your desired region and duration:

# Create a 5-minute tunnel from Frankfurt
curl -X POST https://keyroute.world/v1/tunnel \
  -H "Authorization: Bearer YOUR_KEYKEEPER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "region": "eu-frankfurt",
    "duration": 300
  }'

Request Parameters

Response

{
  "tunnel_id": "tun_f4b047e273e16b48",
  "region": "eu-frankfurt",
  "wireguard_config": "[Interface]\nPrivateKey = ...",
  "endpoint": "134.122.87.87:51820",
  "client_ip": "10.100.0.2",
  "expires_at": "2024-12-01T19:05:00.000Z"
}

The API returns a complete WireGuard configuration. Save it to a file and use it with the WireGuard client:

# Save the config from API response
echo "$WIREGUARD_CONFIG" > /etc/wireguard/keyroute.conf

# Bring up the tunnel
wg-quick up keyroute

# Verify connection
curl https://api.ipify.org  # Should show tunnel's public IP

# When done, bring down the tunnel
wg-quick down keyroute

Sample WireGuard Config

[Interface]
PrivateKey = <your-generated-private-key>
Address = 10.100.0.2/32
DNS = 1.1.1.1

[Peer]
PublicKey = <server-public-key>
Endpoint = 134.122.87.87:51820
AllowedIPs = 0.0.0.0/0
PersistentKeepalive = 25

Get Tunnel Status

Check the status and time remaining on a tunnel:

curl https://keyroute.world/v1/tunnel/tun_f4b047e273e16b48 \
  -H "Authorization: Bearer YOUR_TOKEN"

Close Tunnel Early

Delete a tunnel before it expires. You only pay for the time used:

curl -X DELETE https://keyroute.world/v1/tunnel/tun_f4b047e273e16b48 \
  -H "Authorization: Bearer YOUR_TOKEN"

List All Tunnels

Get all active tunnels for your account:

curl https://keyroute.world/v1/tunnels \
  -H "Authorization: Bearer YOUR_TOKEN"

KeyRoute operates from 4 global regions. Each region has its own public IP address that your traffic will appear to come from.

If you don't specify a region, KeyRoute will automatically select the nearest server based on your location. For consistent geo-targeting, always specify the region explicitly.

KeyRoute uses standard HTTP status codes. All errors return a JSON body with an error field.

{
  "error": "Duration must be between 30 and 3600 seconds"
}