Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hopx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Get the VM agent status, version, and basic health information. This endpoint provides agent metadata rather than cache statistics.
For clearing the execution cache, use the Clear Cache endpoint.

​
Endpoint

GET /cache

​
Request

​
Headers

Authorization: Bearer YOUR_JWT_TOKEN

​
Example Request

curl https://sandbox_abc123xyz.hopx.dev/cache \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

​
Response

​
Success (200 OK)

{
  "agent": "HopX VM Agent (Go)",
  "status": "running",
  "version": "3.2.8",
  "vm_id": "17633354502w4l8eiy",
  "message": "success",
  "timestamp": "2025-11-16T23:25:45Z"
}

​
Response Fields

FieldTypeDescription
agentstringAgent name and runtime
statusstringAgent status (running, stopped)
versionstringAgent version
vm_idstringSandbox/VM identifier
messagestringStatus message
timestampstringResponse timestamp (ISO 8601)

​
Status Codes

CodeDescription
200Success
401Unauthorized

​
Use Cases

​
Check Agent Status

curl https://sandbox_abc123xyz.hopx.dev/cache \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" | \
  jq '{agent, status, version}'

​
Verify Agent Version

VERSION=$(curl -s https://sandbox_abc123xyz.hopx.dev/cache \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" | jq -r '.version')

echo "Agent version: $VERSION"

​
Monitor Agent Health

STATUS=$(curl -s https://sandbox_abc123xyz.hopx.dev/cache \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" | jq -r '.status')

if [ "$STATUS" == "running" ]; then
  echo "✅ Agent is healthy"
else
  echo "⚠️ Agent status: $STATUS"
fi

​
Next Steps