From fab66acb5879f99908b3593c090ca24a2c4b314b Mon Sep 17 00:00:00 2001 From: Yogesh Date: Sun, 6 Sep 2026 10:48:02 +0000 Subject: [PATCH] Point hosted API and MCP examples at api.void-run.com. The production apex is no longer platform.void-run.com. --- advanced/nested-containers.mdx | 16 +++++----- advanced/self-hosted.mdx | 2 +- advanced/ssh-vnc.mdx | 18 ++++++------ core-concepts/background-commands.mdx | 18 ++++++------ core-concepts/code-execution.mdx | 28 +++++++++--------- core-concepts/file-system.mdx | 42 +++++++++++++-------------- core-concepts/lifecycle.mdx | 10 +++---- core-concepts/shell-execution.mdx | 24 +++++++-------- environments/custom-images.mdx | 8 ++--- environments/package-management.mdx | 24 +++++++-------- getting-started/introduction.mdx | 6 ++-- getting-started/quickstart.mdx | 26 ++++++++--------- integrations/mcp.mdx | 18 ++++++------ networking/internet-access.mdx | 12 ++++---- networking/public-urls.mdx | 6 ++-- networking/tailscale.mdx | 16 +++++----- openapi/voidrun.yml | 4 +-- sdks/overview.mdx | 2 +- sdks/python.mdx | 2 +- 19 files changed, 141 insertions(+), 141 deletions(-) diff --git a/advanced/nested-containers.mdx b/advanced/nested-containers.mdx index 011a284..6d98b06 100644 --- a/advanced/nested-containers.mdx +++ b/advanced/nested-containers.mdx @@ -92,13 +92,13 @@ voidrun exec --command "docker info --format '{{.ServerVersion}}'" ```bash cURL # Create sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "docker-sandbox", "image": "docker-lite", "cpu": 4, "mem": 4096}' # Verify Docker is running -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "docker --version"}' @@ -160,7 +160,7 @@ voidrun exec --command "curl -s http://localhost:80" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "docker run -d --name nginx -p 80:80 nginx:latest"}' @@ -240,7 +240,7 @@ voidrun exec --command "docker ps" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "docker network create app-network && docker run -d --name postgres --network app-network -e POSTGRES_PASSWORD=secret postgres:15"}' @@ -335,7 +335,7 @@ voidrun exec --command "kubectl get nodes" ```bash cURL # Install K3s -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "curl -sfL https://get.k3s.io | sh -", "timeout": 120}' @@ -412,7 +412,7 @@ voidrun exec --command "kubectl get pods -o wide" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "kubectl create deployment nginx --image=nginx:latest"}' @@ -492,7 +492,7 @@ voidrun exec --command "df -h" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "free -h && df -h"}' @@ -552,7 +552,7 @@ voidrun exec --command "docker image prune -af && docker volume pru ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "docker stop $(docker ps -aq) 2>/dev/null; docker rm $(docker ps -aq) 2>/dev/null; docker image prune -af"}' diff --git a/advanced/self-hosted.mdx b/advanced/self-hosted.mdx index 100e22e..a4974a1 100644 --- a/advanced/self-hosted.mdx +++ b/advanced/self-hosted.mdx @@ -5,7 +5,7 @@ description: How private or self-managed API endpoints relate to the public docs # Self-hosted deployments -This documentation site targets the **hosted VoidRun platform** base URL exemplified in guides (**`https://platform.void-run.com/api`**) and the **OpenAPI** description bundled at **`docs/openapi/voidrun.yml`**. +This documentation site targets the **hosted VoidRun platform** base URL exemplified in guides (**`https://api.void-run.com/api`**) and the **OpenAPI** description bundled at **`docs/openapi/voidrun.yml`**. ## What may differ on your deployment diff --git a/advanced/ssh-vnc.mdx b/advanced/ssh-vnc.mdx index 35823fc..2a280c9 100644 --- a/advanced/ssh-vnc.mdx +++ b/advanced/ssh-vnc.mdx @@ -105,14 +105,14 @@ voidrun get ```bash cURL # Create a sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "ssh-demo", "cpu": 2, "mem": 2048}' # TODO: Verify exact endpoint for SSH credentials # Example expected endpoint: -# curl -X GET "https://platform.void-run.com/api/sandboxes//ssh" \ +# curl -X GET "https://api.void-run.com/api/sandboxes//ssh" \ # -H "X-API-Key: $VR_API_KEY" ``` @@ -328,7 +328,7 @@ voidrun exec --command "vncserver -list" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo apt-get update && sudo apt-get install -y xfce4 xfce4-goodies tightvncserver"}' @@ -400,7 +400,7 @@ voidrun get ```bash cURL # TODO: Verify exact endpoint for VNC configuration # Example expected endpoint: -# curl -X GET "https://platform.void-run.com/api/sandboxes//vnc" \ +# curl -X GET "https://api.void-run.com/api/sandboxes//vnc" \ # -H "X-API-Key: $VR_API_KEY" ``` @@ -487,7 +487,7 @@ voidrun exec --command "websockify --web=/usr/share/novnc/ 6080 loc ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo apt-get install -y novnc websockify && websockify --web=/usr/share/novnc/ 6080 localhost:5901 &"}' @@ -589,7 +589,7 @@ voidrun download /tmp/screenshot.png ./screenshot.png ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo apt-get install -y chromium-browser && pip install selenium"}' @@ -664,7 +664,7 @@ voidrun exec --command "while true; do sleep 60; done &" ```bash cURL # Wake sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes//wake" \ +curl -X POST "https://api.void-run.com/api/sandboxes//wake" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -713,11 +713,11 @@ voidrun wake ```bash cURL # Check sandbox status -curl -X GET "https://platform.void-run.com/api/sandboxes/" \ +curl -X GET "https://api.void-run.com/api/sandboxes/" \ -H "X-API-Key: $VR_API_KEY" # Wake if snapshotted -curl -X POST "https://platform.void-run.com/api/sandboxes//wake" \ +curl -X POST "https://api.void-run.com/api/sandboxes//wake" \ -H "X-API-Key: $VR_API_KEY" ``` diff --git a/core-concepts/background-commands.mdx b/core-concepts/background-commands.mdx index 9505f13..3250e01 100644 --- a/core-concepts/background-commands.mdx +++ b/core-concepts/background-commands.mdx @@ -23,7 +23,7 @@ For a full comparison with sync **`exec`**, streaming, PTY, and **`runCode`**, s ## REST endpoints -All routes are under **`/sandboxes/{id}/commands/`** (prefix with your API base, e.g. **`https://platform.void-run.com/api`**). Authenticate with **`X-API-Key`**. +All routes are under **`/sandboxes/{id}/commands/`** (prefix with your API base, e.g. **`https://api.void-run.com/api`**). Authenticate with **`X-API-Key`**. | Method | Path | Role | |--------|------|------| @@ -113,7 +113,7 @@ voidrun bg run --command 'npm run dev' --cwd /app ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/run" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/run" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -154,7 +154,7 @@ voidrun bg list ``` ```bash cURL -curl -X GET "https://platform.void-run.com/api/sandboxes//commands/list" \ +curl -X GET "https://api.void-run.com/api/sandboxes//commands/list" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -199,7 +199,7 @@ voidrun bg wait --pid ```bash cURL # Replace 12345 with the PID from commands/run -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/wait" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/wait" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"pid": 12345}' @@ -261,7 +261,7 @@ voidrun bg run --command 'echo use SDK or cURL for attach' ```bash cURL # Replace 12345 with the PID from commands/run -curl -N -X POST "https://platform.void-run.com/api/sandboxes//commands/attach" \ +curl -N -X POST "https://api.void-run.com/api/sandboxes//commands/attach" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -H "Accept: text/event-stream" \ @@ -299,7 +299,7 @@ voidrun bg kill --pid ```bash cURL # Replace 12345 with the PID from commands/run -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/kill" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/kill" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"pid": 12345}' @@ -358,15 +358,15 @@ voidrun bg wait --pid ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/run" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/run" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "npm run dev", "cwd": "/app", "timeout": 0}' -curl -X GET "https://platform.void-run.com/api/sandboxes//commands/list" \ +curl -X GET "https://api.void-run.com/api/sandboxes//commands/list" \ -H "X-API-Key: $VR_API_KEY" -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/wait" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/wait" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"pid": 12345}' diff --git a/core-concepts/code-execution.mdx b/core-concepts/code-execution.mdx index 81112ec..386a85f 100644 --- a/core-concepts/code-execution.mdx +++ b/core-concepts/code-execution.mdx @@ -85,13 +85,13 @@ voidrun exec --command 'echo "Hello, VoidRun!" && pwd' ```bash cURL # Create sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"cpu": 2, "mem": 2048}' # Execute command (replace ) -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "echo \"Hello, VoidRun!\" && pwd"}' @@ -168,7 +168,7 @@ voidrun exec --command 'python3 /app/script.py' ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "python3 -c \"print(2 + 2)\""}' @@ -233,7 +233,7 @@ voidrun exec --command 'node /app/script.js' ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "node -e \"console.log(2 + 2)\""}' @@ -295,7 +295,7 @@ voidrun exec --command 'echo "Hostname: $(hostname)" && date && upt ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "echo \"Hostname: $(hostname)\" && date"}' @@ -360,7 +360,7 @@ voidrun exec --command 'ls -la /nonexistent' ```bash cURL # Response includes stdout, stderr, and exitCode -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "ls -la /nonexistent"}' @@ -430,7 +430,7 @@ voidrun exec --command 'python3 -c "import json; print(json.dumps({ ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "python3 -c \"import json; print(json.dumps({\\\"name\\\": \\\"VoidRun\\\"}))\""}' @@ -491,7 +491,7 @@ voidrun exec --command 'for i in {1..10}; do echo "Count: $i"; slee ```bash cURL # Use the exec-stream endpoint for SSE streaming -curl -N "https://platform.void-run.com/api/sandboxes//exec-stream" \ +curl -N "https://api.void-run.com/api/sandboxes//exec-stream" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "for i in {1..10}; do echo \"Count: $i\"; sleep 1; done"}' @@ -555,7 +555,7 @@ voidrun exec --command 'sleep 30 && echo "Done"' --timeout 60 ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sleep 30 && echo \"Done\"", "timeout": 60}' @@ -603,7 +603,7 @@ voidrun exec --command 'pwd && ls -la' --cwd /app/src ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "pwd && ls -la", "cwd": "/app/src"}' @@ -657,7 +657,7 @@ voidrun exec --command 'API_KEY=secret DEBUG=true && echo "API Key: ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -734,13 +734,13 @@ voidrun bg kill --pid ```bash cURL # Start background process -curl -X POST "https://platform.void-run.com/api/sandboxes//commands/run" \ +curl -X POST "https://api.void-run.com/api/sandboxes//commands/run" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "npm run dev", "cwd": "/app", "timeout": 0}' # List processes -curl -X GET "https://platform.void-run.com/api/sandboxes//commands/list" \ +curl -X GET "https://api.void-run.com/api/sandboxes//commands/list" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -806,7 +806,7 @@ voidrun exec --command 'some-command' ```bash cURL # Check response for exitCode field -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "some-command"}' diff --git a/core-concepts/file-system.mdx b/core-concepts/file-system.mdx index d27b876..463a756 100644 --- a/core-concepts/file-system.mdx +++ b/core-concepts/file-system.mdx @@ -97,7 +97,7 @@ voidrun fs upload --source ./config.json --dest /app/config.json ```bash cURL # Upload file content -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload?path=/app/config.json" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload?path=/app/config.json" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "VoidRun", "version": "1.0.0"}' @@ -154,7 +154,7 @@ voidrun fs upload --source ./image.png --dest /remote/image.png ```bash cURL # Upload binary file with multipart -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload?path=/remote/image.png" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload?path=/remote/image.png" \ -H "X-API-Key: $VR_API_KEY" \ -F "file=@./image.png" ``` @@ -207,7 +207,7 @@ voidrun fs upload --source ./large-dataset.tar.gz --dest /remote/la ```bash cURL # Upload large file -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload?path=/remote/large.tar.gz" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload?path=/remote/large.tar.gz" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/octet-stream" \ --data-binary @./large-dataset.tar.gz @@ -262,7 +262,7 @@ cat ./output.json ```bash cURL # Download file -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/download?path=/app/output.json" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/download?path=/app/output.json" \ -H "X-API-Key: $VR_API_KEY" \ -o output.json ``` @@ -329,7 +329,7 @@ voidrun fs download --source /remote/large-log.txt --dest ./large-l ```bash cURL # Download large file -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/download?path=/remote/large-log.txt" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/download?path=/remote/large-log.txt" \ -H "X-API-Key: $VR_API_KEY" \ -o large-log.txt ``` @@ -374,7 +374,7 @@ voidrun fs list --path /app ``` ```bash cURL -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/list?path=/app" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/list?path=/app" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -420,11 +420,11 @@ voidrun fs mkdir --path /app/data/logs ```bash cURL # Create file -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/create-file?path=/app/newfile.txt" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/create-file?path=/app/newfile.txt" \ -H "X-API-Key: $VR_API_KEY" # Create directory -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/create-directory?path=/app/data/logs" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/create-directory?path=/app/data/logs" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -470,13 +470,13 @@ voidrun fs move --from /app/old-name.txt --to /app/new-name.txt ```bash cURL # Copy file -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/copy" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/copy" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"from": "/app/source.txt", "to": "/app/destination.txt"}' # Move file -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/move" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/move" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"from": "/app/old-name.txt", "to": "/app/new-name.txt"}' @@ -514,7 +514,7 @@ voidrun fs delete --path /app/obsolete.txt ``` ```bash cURL -curl -X DELETE "https://platform.void-run.com/api/sandboxes//fs/delete?path=/app/obsolete.txt" \ +curl -X DELETE "https://api.void-run.com/api/sandboxes//fs/delete?path=/app/obsolete.txt" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -554,7 +554,7 @@ voidrun fs stat --path /app/data.json ``` ```bash cURL -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/stat?path=/app/data.json" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/stat?path=/app/data.json" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -594,7 +594,7 @@ voidrun fs search --path /app --pattern "*.py" ``` ```bash cURL -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/search?path=/app&pattern=*.py" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/search?path=/app&pattern=*.py" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -639,7 +639,7 @@ voidrun fs compress --path /app/data --format tar.gz ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/compress" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/compress" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"path": "/app/data", "format": "tar.gz"}' @@ -683,7 +683,7 @@ voidrun fs extract --archive /app/data.tar.gz --dest /app/extracted ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/extract" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/extract" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"archive": "/app/data.tar.gz", "dest": "/app/extracted"}' @@ -749,7 +749,7 @@ voidrun fs watch --path /app --recursive ```bash cURL # File watching: start a session (HTTP), then open a WebSocket to the stream URL. # 1) POST .../files/watch with JSON body {"path":"/app","recursive":true} -# 2) Connect (TLS): wss://platform.void-run.com/api/sandboxes//files/watch//stream +# 2) Connect (TLS): wss://api.void-run.com/api/sandboxes//files/watch//stream # Use the sessionId from the start-watch response; pass X-API-Key when the server expects it on upgrade. ``` @@ -944,30 +944,30 @@ voidrun delete $SANDBOX_ID # Complete workflow via cURL # 1. Create sandbox -SANDBOX_ID=$(curl -s -X POST "https://platform.void-run.com/api/sandboxes" \ +SANDBOX_ID=$(curl -s -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"data-processor","cpu":2,"mem":4096}' | jq -r '.data.id') # 2. Upload input data -curl -X POST "https://platform.void-run.com/api/sandboxes/$SANDBOX_ID/fs/upload?path=/data/input.json" \ +curl -X POST "https://api.void-run.com/api/sandboxes/$SANDBOX_ID/fs/upload?path=/data/input.json" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"records":[{"id":1,"value":100},{"id":2,"value":200}]}' # 3. Run processing -curl -X POST "https://platform.void-run.com/api/sandboxes/$SANDBOX_ID/exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes/$SANDBOX_ID/exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "python3 -c \"import json; print(\\\"Done\\\")\""}' # 4. Download results -curl -X GET "https://platform.void-run.com/api/sandboxes/$SANDBOX_ID/fs/download?path=/data/output.json" \ +curl -X GET "https://api.void-run.com/api/sandboxes/$SANDBOX_ID/fs/download?path=/data/output.json" \ -H "X-API-Key: $VR_API_KEY" \ -o output.json # 5. Clean up -curl -X DELETE "https://platform.void-run.com/api/sandboxes/$SANDBOX_ID" \ +curl -X DELETE "https://api.void-run.com/api/sandboxes/$SANDBOX_ID" \ -H "X-API-Key: $VR_API_KEY" ``` diff --git a/core-concepts/lifecycle.mdx b/core-concepts/lifecycle.mdx index 5f7ddbe..182b722 100644 --- a/core-concepts/lifecycle.mdx +++ b/core-concepts/lifecycle.mdx @@ -128,7 +128,7 @@ print("Sandbox snapshotted") ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//sleep" \ +curl -X POST "https://api.void-run.com/api/sandboxes//sleep" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -159,7 +159,7 @@ print("Sandbox running") ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//wake" \ +curl -X POST "https://api.void-run.com/api/sandboxes//wake" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -188,7 +188,7 @@ sandbox.start() ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//start" \ +curl -X POST "https://api.void-run.com/api/sandboxes//start" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -225,7 +225,7 @@ sandbox.remove() ``` ```bash cURL -curl -X DELETE "https://platform.void-run.com/api/sandboxes/" \ +curl -X DELETE "https://api.void-run.com/api/sandboxes/" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -309,7 +309,7 @@ def run_ai_agent(): ```bash cURL # Create with autoSleep so the platform snapshots on idle -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"ai-agent-session","cpu":4,"mem":4096,"autoSleep":true}' diff --git a/core-concepts/shell-execution.mdx b/core-concepts/shell-execution.mdx index 6acb7f0..3f1f491 100644 --- a/core-concepts/shell-execution.mdx +++ b/core-concepts/shell-execution.mdx @@ -8,7 +8,7 @@ description: Shell commands and processes in a VoidRun sandbox—sync exec, stre This page is the **single map** of how to run work inside a running sandbox: one-shot shell commands, live streams, detached processes, optional PTY session HTTP actions, and the **code interpreter** shortcut. For language-specific runtime details and longer tutorials, still use [Code execution](/core-concepts/code-execution), [Background commands](/core-concepts/background-commands), and [PTY](/core-concepts/pty). -Replace `` with your sandbox id. Set **`VR_API_KEY`**. Hosted default API base is the same as OpenAPI **`servers`** (for example `https://platform.void-run.com/api`). Self-hosted: set **`VR_API_URL`** / **`baseUrl`**. See [SDKs & API](/sdks/overview). +Replace `` with your sandbox id. Set **`VR_API_KEY`**. Hosted default API base is the same as OpenAPI **`servers`** (for example `https://api.void-run.com/api`). Self-hosted: set **`VR_API_URL`** / **`baseUrl`**. See [SDKs & API](/sdks/overview). ## Capabilities at a glance @@ -73,7 +73,7 @@ voidrun delete ``` ```bash cURL -curl -s -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "echo \"hello\" && pwd", "cwd": "/tmp", "env": {"MY_VAR": "1"}, "timeout": 60}' @@ -142,7 +142,7 @@ voidrun exec \ ``` ```bash cURL -curl -N -X POST "https://platform.void-run.com/api/sandboxes//exec-stream" \ +curl -N -X POST "https://api.void-run.com/api/sandboxes//exec-stream" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -H "Accept: text/event-stream" \ @@ -225,30 +225,30 @@ voidrun bg kill --pid ```bash cURL # Start -curl -s -X POST "https://platform.void-run.com/api/sandboxes//commands/run" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//commands/run" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sleep 2 && echo done", "cwd": "/tmp", "timeout": 0}' # List -curl -s "https://platform.void-run.com/api/sandboxes//commands/list" \ +curl -s "https://api.void-run.com/api/sandboxes//commands/list" \ -H "X-API-Key: $VR_API_KEY" # Wait -curl -s -X POST "https://platform.void-run.com/api/sandboxes//commands/wait" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//commands/wait" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"pid": 12345}' # Attach (SSE) -curl -N -X POST "https://platform.void-run.com/api/sandboxes//commands/attach" \ +curl -N -X POST "https://api.void-run.com/api/sandboxes//commands/attach" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -H "Accept: text/event-stream" \ -d '{"pid": 12345}' # Kill -curl -s -X POST "https://platform.void-run.com/api/sandboxes//commands/kill" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//commands/kill" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"pid": 12345}' @@ -288,7 +288,7 @@ voidrun exec --command 'python3 -c "print(2 + 2)"' ``` ```bash cURL -curl -s -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "python3 -c \"print(2 + 2)\""}' @@ -364,7 +364,7 @@ import { VoidRun } from '@voidrun/sdk'; const apiKey = process.env.VR_API_KEY!; const base = process.env.VR_API_URL?.replace(/\/$/, '') ?? - 'https://platform.void-run.com/api'; + 'https://api.void-run.com/api'; const vr = new VoidRun({ apiKey }); const sandbox = await vr.getSandbox(''); @@ -433,13 +433,13 @@ print(out.output, out.exit_code) ```bash cURL # Create session -curl -s -X POST "https://platform.void-run.com/api/sandboxes//session-exec" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//session-exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"action": "create", "shell": "/bin/bash"}' # Run command in session (replace SESSION_ID) -curl -s -X POST "https://platform.void-run.com/api/sandboxes//session-exec" \ +curl -s -X POST "https://api.void-run.com/api/sandboxes//session-exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"action": "exec", "sessionId": "SESSION_ID", "command": "pwd"}' diff --git a/environments/custom-images.mdx b/environments/custom-images.mdx index daacba7..8a4bfa1 100644 --- a/environments/custom-images.mdx +++ b/environments/custom-images.mdx @@ -107,7 +107,7 @@ voidrun exec --command "python3 --version" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -170,7 +170,7 @@ const apiKey = process.env.VR_API_KEY!; const vr = new VoidRun({ apiKey }); // Same default host as OpenAPI `servers` / cURL below; self-hosted: pass `baseUrl` to `VoidRun` and use that root here. -const apiRoot = 'https://platform.void-run.com/api'; +const apiRoot = 'https://api.void-run.com/api'; const res = await fetch(`${apiRoot.replace(/\/$/, '')}/images`, { headers: { 'X-API-Key': apiKey }, @@ -206,7 +206,7 @@ sandbox = vr.create_sandbox(name="custom-app", image="code", cpu=2, mem=2048) ``` ```bash cURL -curl -sS "https://platform.void-run.com/api/images" \ +curl -sS "https://api.void-run.com/api/images" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -297,7 +297,7 @@ voidrun create --template code --env NODE_ENV=production --env DATABASE_URL=post ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ diff --git a/environments/package-management.mdx b/environments/package-management.mdx index 008bb18..4108f23 100644 --- a/environments/package-management.mdx +++ b/environments/package-management.mdx @@ -101,13 +101,13 @@ voidrun exec --command "ffmpeg -version" ```bash cURL # Update package lists -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "apt-get update"}' # Install system packages -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "apt-get install -y ffmpeg git curl", "timeout": 120}' @@ -217,7 +217,7 @@ voidrun exec --command "python3 -c 'import pandas; print(pandas.__v ```bash cURL # Install Python packages -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "pip install pandas numpy scikit-learn", "timeout": 120}' @@ -263,7 +263,7 @@ voidrun exec --command 'pip install "numpy>=1.20,<2.0"' ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "pip install tensorflow==2.15.0"}' @@ -331,7 +331,7 @@ voidrun exec --command "pip install -r /app/requirements.txt" --tim ```bash cURL # Upload requirements.txt -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload?path=/app/requirements.txt" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload?path=/app/requirements.txt" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: text/plain" \ -d 'pandas==2.0.0 @@ -339,7 +339,7 @@ numpy>=1.20 requests' # Install from requirements.txt -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "pip install -r /app/requirements.txt", "timeout": 180}' @@ -436,13 +436,13 @@ voidrun exec --command "cd /app && npm install express axios lodash ```bash cURL # Initialize npm project -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "mkdir -p /app && cd /app && npm init -y"}' # Install npm packages -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "cd /app && npm install express axios lodash", "timeout": 120}' @@ -517,13 +517,13 @@ voidrun exec --command "cd /app && npm install" --timeout 120 ```bash cURL # Upload package.json -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload?path=/app/package.json" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload?path=/app/package.json" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"my-app","dependencies":{"express":"^4.18.0"}}' # Install dependencies -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "cd /app && npm install", "timeout": 120}' @@ -656,13 +656,13 @@ voidrun exec --command "python3 -c 'import requests; print(requests ```bash cURL # Create sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"image": "code", "cpu": 4, "mem": 4096}' # Install packages -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "pip install requests beautifulsoup4"}' diff --git a/getting-started/introduction.mdx b/getting-started/introduction.mdx index b4b638f..ec6e95d 100644 --- a/getting-started/introduction.mdx +++ b/getting-started/introduction.mdx @@ -123,13 +123,13 @@ voidrun delete ```bash cURL # Create sandbox -curl -X POST https://platform.void-run.com/api/sandboxes \ +curl -X POST https://api.void-run.com/api/sandboxes \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"cpu": 2, "mem": 2048}' # Execute code (replace with actual ID) -curl -X POST https://platform.void-run.com/api/sandboxes//exec \ +curl -X POST https://api.void-run.com/api/sandboxes//exec \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "python3 -c \"print(\\\"Hello from VoidRun\\\")\""}' @@ -178,7 +178,7 @@ voidrun delete ``` ```bash cURL -curl -X POST https://platform.void-run.com/api/sandboxes \ +curl -X POST https://api.void-run.com/api/sandboxes \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"image": "code", "cpu": 4, "mem": 4096}' diff --git a/getting-started/quickstart.mdx b/getting-started/quickstart.mdx index 305df1a..2e97472 100644 --- a/getting-started/quickstart.mdx +++ b/getting-started/quickstart.mdx @@ -130,7 +130,7 @@ voidrun create \ ``` ```bash cURL -curl -X POST https://platform.void-run.com/api/sandboxes \ +curl -X POST https://api.void-run.com/api/sandboxes \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -197,13 +197,13 @@ voidrun exec --command 'npm install && npm run build' --stream ```bash cURL # Execute a command -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "echo \"Hello from VoidRun!\""}' # Stream command output (SSE endpoint) -curl -N "https://platform.void-run.com/api/sandboxes//exec-stream" \ +curl -N "https://api.void-run.com/api/sandboxes//exec-stream" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "npm install && npm run build"}' @@ -273,18 +273,18 @@ voidrun fs delete --path /app/hello.txt ```bash cURL # Upload a file -curl -X POST "https://platform.void-run.com/api/sandboxes//fs/upload" \ +curl -X POST "https://api.void-run.com/api/sandboxes//fs/upload" \ -H "X-API-Key: $VR_API_KEY" \ -F "file=@./local-file.txt" \ -F "path=/app/hello.txt" # Download a file -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/download?path=/app/hello.txt" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/download?path=/app/hello.txt" \ -H "X-API-Key: $VR_API_KEY" \ -o downloaded.txt # List files -curl -X GET "https://platform.void-run.com/api/sandboxes//fs/list?path=/app" \ +curl -X GET "https://api.void-run.com/api/sandboxes//fs/list?path=/app" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -357,7 +357,7 @@ voidrun run-code --language python --file ./script.py ```bash cURL # Run code via exec endpoint -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -425,23 +425,23 @@ voidrun delete ```bash cURL # List all sandboxes -curl -X GET "https://platform.void-run.com/api/sandboxes" \ +curl -X GET "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" # Get sandbox details -curl -X GET "https://platform.void-run.com/api/sandboxes/" \ +curl -X GET "https://api.void-run.com/api/sandboxes/" \ -H "X-API-Key: $VR_API_KEY" # Sleep a sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes//sleep" \ +curl -X POST "https://api.void-run.com/api/sandboxes//sleep" \ -H "X-API-Key: $VR_API_KEY" # Wake a sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes//wake" \ +curl -X POST "https://api.void-run.com/api/sandboxes//wake" \ -H "X-API-Key: $VR_API_KEY" # Delete a sandbox -curl -X DELETE "https://platform.void-run.com/api/sandboxes/" \ +curl -X DELETE "https://api.void-run.com/api/sandboxes/" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -565,7 +565,7 @@ echo "Sandbox deleted" #!/bin/bash VR_API_KEY="your-api-key" -BASE_URL="https://platform.void-run.com/api" +BASE_URL="https://api.void-run.com/api" # Create sandbox SANDBOX_ID=$(curl -s -X POST "$BASE_URL/sandboxes" \ diff --git a/integrations/mcp.mdx b/integrations/mcp.mdx index 8de4239..113f461 100644 --- a/integrations/mcp.mdx +++ b/integrations/mcp.mdx @@ -25,7 +25,7 @@ VoidRun is a **remote** MCP server: your client opens **HTTPS** (or local **HTTP | Item | Detail | |------|--------| | **Transport** | [Streamable HTTP](https://modelcontextprotocol.io/) MCP | -| **Endpoint** | `POST {baseUrl}/mcp` where `{baseUrl}` is your API root including **`/api`** (example: `https://platform.void-run.com/api/mcp`) | +| **Endpoint** | `POST {baseUrl}/mcp` where `{baseUrl}` is your API root including **`/api`** (example: `https://api.void-run.com/api/mcp`) | | **Auth** | **`X-API-Key`** on every authenticated MCP request (same as REST) | | **Capabilities** | Create/list/get/delete sandboxes, **`execute_command`**, **`run_code`**, filesystem tools, background commands, read-only **resources** for discovery | @@ -50,7 +50,7 @@ After **`initialize`**, clients must send the **`Mcp-Session-Id`** header on lat | Environment | Base URL | MCP URL | |-------------|----------|---------| -| Hosted (VoidRun Cloud) | `https://platform.void-run.com/api` | `https://platform.void-run.com/api/mcp` | +| Hosted (VoidRun Cloud) | `https://api.void-run.com/api` | `https://api.void-run.com/api/mcp` | | Local `go run` default | `http://127.0.0.1:33944/api` (or your `SERVER_PORT`) | `http://127.0.0.1:33944/api/mcp` | Self-hosted: replace the host and path prefix with whatever **`VR_API_URL`** points at (see [Self-hosted deployments](/advanced/self-hosted)), then append **`/mcp`**. @@ -75,7 +75,7 @@ Do not commit real API keys. Prefer **environment substitution** (Cursor **`${en { "mcpServers": { "voidrun": { - "url": "https://platform.void-run.com/api/mcp", + "url": "https://api.void-run.com/api/mcp", "headers": { "X-API-Key": "${env:VR_API_KEY}" } @@ -110,7 +110,7 @@ VS Code stores MCP in **`mcp.json`**: either **`.vscode/mcp.json`** in the works "servers": { "voidrun": { "type": "http", - "url": "https://platform.void-run.com/api/mcp", + "url": "https://api.void-run.com/api/mcp", "headers": { "X-API-Key": "${input:voidrun-api-key}" } @@ -130,7 +130,7 @@ VS Code stores MCP in **`mcp.json`**: either **`.vscode/mcp.json`** in the works **One-off (user or local scope):** ```bash -claude mcp add --transport http voidrun https://platform.void-run.com/api/mcp \ +claude mcp add --transport http voidrun https://api.void-run.com/api/mcp \ --header "X-API-Key: YOUR_KEY_HERE" ``` @@ -143,7 +143,7 @@ Use **`--scope project`** to write the team-shared **`.mcp.json`** at the projec "mcpServers": { "voidrun": { "type": "http", - "url": "https://platform.void-run.com/api/mcp", + "url": "https://api.void-run.com/api/mcp", "headers": { "X-API-Key": "${VR_API_KEY}" } @@ -160,7 +160,7 @@ Applies to **claude.ai**, **Claude Desktop**, **Cowork**, and mobile when using Anthropic’s **custom connectors** path lets you attach a **remote MCP URL** from **claude.ai**, **Claude Desktop**, **Cowork**, and mobile, with traffic originating from **Anthropic’s cloud** (not only your laptop). That means: -- Your MCP URL (**`https://platform.void-run.com/api/mcp`** for hosted VoidRun) must be reachable from the **public internet** (or you must allowlist [Anthropic IP ranges](https://platform.claude.com/docs/en/api/ip-addresses)). +- Your MCP URL (**`https://api.void-run.com/api/mcp`** for hosted VoidRun) must be reachable from the **public internet** (or you must allowlist [Anthropic IP ranges](https://platform.claude.com/docs/en/api/ip-addresses)). - Follow **Customize → Connectors** and Anthropic’s walkthrough: [Get started with custom connectors using remote MCP](https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp). @@ -177,7 +177,7 @@ In supported JetBrains IDEs, open **GitHub Copilot Chat** in **Agent** mode, use Any editor or agent runtime that supports **remote MCP over HTTP** (Streamable HTTP, with optional SSE fallback) can reuse: -- **URL:** `https://platform.void-run.com/api/mcp` (hosted) or `http://localhost:/api/mcp` (local). +- **URL:** `https://api.void-run.com/api/mcp` (hosted) or `http://localhost:/api/mcp` (local). - **Header:** `X-API-Key: ` (same as REST). Consult that product’s MCP documentation for the exact JSON schema (`headers` vs `requestInit`, env substitution, OAuth, etc.). @@ -197,7 +197,7 @@ Useful to verify connectivity and tool names without the IDE. **CLI (list tools):** ```bash -npx @modelcontextprotocol/inspector --cli "https://platform.void-run.com/api/mcp" \ +npx @modelcontextprotocol/inspector --cli "https://api.void-run.com/api/mcp" \ --transport http \ --header "X-API-Key: $VR_API_KEY" \ --method tools/list diff --git a/networking/internet-access.mdx b/networking/internet-access.mdx index 6f0eb02..29d1ec4 100644 --- a/networking/internet-access.mdx +++ b/networking/internet-access.mdx @@ -94,13 +94,13 @@ voidrun exec --command "curl -s --connect-timeout 5 https://google. ```bash cURL # Create sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "isolated-sandbox", "cpu": 2, "mem": 2048}' # Disable outbound internet -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "iptables -A OUTPUT -p tcp --dport 80 -j DROP && iptables -A OUTPUT -p tcp --dport 443 -j DROP"}' @@ -153,7 +153,7 @@ voidrun exec --command "curl -s --connect-timeout 5 https://api.ipi ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "iptables -D OUTPUT -p tcp --dport 80 -j DROP 2>/dev/null; iptables -D OUTPUT -p tcp --dport 443 -j DROP 2>/dev/null"}' @@ -262,7 +262,7 @@ voidrun exec --command "curl -s https://api.github.com/zen" ```bash cURL # Configure allowlist -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "iptables -A OUTPUT -p tcp --dport 443 -j DROP && iptables -I OUTPUT -d $(dig +short api.github.com | head -1) -p tcp --dport 443 -j ACCEPT"}' @@ -325,7 +325,7 @@ iptables -I OUTPUT -d 10.0.0.50 -p tcp --dport 443 -j ACCEPT ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "iptables -A OUTPUT -p tcp --dport 443 -j DROP && iptables -I OUTPUT -d 192.168.1.100 -p tcp --dport 443 -j ACCEPT"}' @@ -414,7 +414,7 @@ voidrun exec --command "curl -s --connect-timeout 5 https://faceboo ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "iptables -A OUTPUT -d $(dig +short facebook.com | head -1) -j DROP"}' diff --git a/networking/public-urls.mdx b/networking/public-urls.mdx index 4f5815f..dbfe3bf 100644 --- a/networking/public-urls.mdx +++ b/networking/public-urls.mdx @@ -70,7 +70,7 @@ voidrun exec --command "python3 -m http.server 8080 &" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -122,7 +122,7 @@ voidrun public-urls --json ``` ```bash cURL -curl -X GET "https://platform.void-run.com/api/sandboxes//public-urls" \ +curl -X GET "https://api.void-run.com/api/sandboxes//public-urls" \ -H "X-API-Key: $VR_API_KEY" ``` @@ -149,7 +149,7 @@ Use `PATCH /sandboxes/{id}/publish-ports` to replace the list. The gateway recon ```bash cURL -curl -X PATCH "https://platform.void-run.com/api/sandboxes//publish-ports" \ +curl -X PATCH "https://api.void-run.com/api/sandboxes//publish-ports" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"publishPorts": [8080]}' diff --git a/networking/tailscale.mdx b/networking/tailscale.mdx index f77e803..135d357 100644 --- a/networking/tailscale.mdx +++ b/networking/tailscale.mdx @@ -114,13 +114,13 @@ voidrun exec --command "sudo tailscale status" ```bash cURL # Create a sandbox -curl -X POST "https://platform.void-run.com/api/sandboxes" \ +curl -X POST "https://api.void-run.com/api/sandboxes" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "tailscale-sandbox", "cpu": 2, "mem": 2048}' # Connect to Tailscale -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo tailscale up --authkey=$TAILSCALE_AUTH_KEY --hostname=voidrun-sandbox"}' @@ -169,7 +169,7 @@ voidrun exec --command "sudo tailscale up --authkey=$TAILSCALE_AUTH ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo tailscale up --authkey=$TAILSCALE_AUTH_KEY --hostname=voidrun-agent --tag=tag:voidrun"}' @@ -231,7 +231,7 @@ voidrun exec --command "curl -s http://postgres.internal.ts.net:543 ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "curl -s http://internal-api.tailnet-name.tsvc:8080/health"}' @@ -282,7 +282,7 @@ voidrun exec --command 'PGPASSWORD=secret psql -h postgres.internal ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo apt-get update && sudo apt-get install -y postgresql-client"}' @@ -321,7 +321,7 @@ voidrun exec --command 'ssh user@internal-server.tailnet-name.ts.ne ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "ssh user@internal-server.tailnet-name.ts.net \"uname -a\""}' @@ -395,7 +395,7 @@ voidrun exec --command "sudo tailscale ip -4" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo tailscale status"}' @@ -467,7 +467,7 @@ voidrun exec --command "sudo tailscale down" ``` ```bash cURL -curl -X POST "https://platform.void-run.com/api/sandboxes//exec" \ +curl -X POST "https://api.void-run.com/api/sandboxes//exec" \ -H "X-API-Key: $VR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"command": "sudo tailscale down"}' diff --git a/openapi/voidrun.yml b/openapi/voidrun.yml index b02fc62..6bac77d 100644 --- a/openapi/voidrun.yml +++ b/openapi/voidrun.yml @@ -13,7 +13,7 @@ info: name: Proprietary servers: - - url: https://platform.void-run.com/api + - url: https://api.void-run.com/api description: Production server tags: @@ -278,7 +278,7 @@ components: diskMB: type: integer description: Disk size in MiB - example: 5120 + example: 10240 status: type: string description: >- diff --git a/sdks/overview.mdx b/sdks/overview.mdx index a02d31e..c92e1a6 100644 --- a/sdks/overview.mdx +++ b/sdks/overview.mdx @@ -56,7 +56,7 @@ Both SDKs use the **same packaged default API base URL** as OpenAPI **`servers`* ### Interactive API Reference -This documentation site includes an **API Reference** tab generated from a bundled copy of the spec at **`docs/openapi/voidrun.yml`** (synced from `voidrun/openapi.yml` in the monorepo: refresh the copy when the canonical spec changes). The spec’s **`servers`** entry (e.g. `https://platform.void-run.com/api`) drives the API playground base URL. +This documentation site includes an **API Reference** tab generated from a bundled copy of the spec at **`docs/openapi/voidrun.yml`** (synced from `voidrun/openapi.yml` in the monorepo: refresh the copy when the canonical spec changes). The spec’s **`servers`** entry (e.g. `https://api.void-run.com/api`) drives the API playground base URL. **Contributors:** keep **`docs/openapi/voidrun.yml`** in sync with **`voidrun/openapi.yml`**. MCP tools follow the same HTTP contract as REST; extend **`voidrun/openapi.yml`**, MCP handlers, and this site’s OpenAPI copy together when fields change. **Branding:** Mintlify maps **`logo.light`** to the navbar asset in **dark** UI and **`logo.dark`** in **light** UI (see [Mintlify appearance and branding](https://mintlify.com/docs/organize/settings)). diff --git a/sdks/python.mdx b/sdks/python.mdx index 77f7b83..05608cb 100644 --- a/sdks/python.mdx +++ b/sdks/python.mdx @@ -55,7 +55,7 @@ Aligned with `@voidrun/sdk`: | Constant | Value | Meaning | |----------|-------|---------| -| `DEFAULT_API_BASE_URL` | `https://platform.void-run.com/api` | Default API host (strip trailing slash in client) | +| `DEFAULT_API_BASE_URL` | `https://api.void-run.com/api` | Default API host (strip trailing slash in client) | | `DEFAULT_SANDBOX_IMAGE` | `"code"` | Default `image` when creating a sandbox | | `DEFAULT_SANDBOX_CPU` | `1` | Default CPU count | | `DEFAULT_SANDBOX_MEM` | `1024` | Default memory (MB) |