Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Base URL

bash
https://app.opencomputer.dev/api

Authentication

All requests require an API key passed via the X-API-Key header.
bash
curl https://app.opencomputer.dev/api/sandboxes \
  -H "X-API-Key: $OPENCOMPUTER_API_KEY"

WebSocket Authentication

WebSocket endpoints accept auth via query parameter:
bash
wss://app.opencomputer.dev/api/sandboxes/{id}/exec/{sessionID}?api_key=<key>

Error Format

All errors use a consistent JSON envelope:
json
{
  "error": "descriptive error message"
}
Status CodeMeaning
400Invalid request (missing fields, bad values)
401Missing or invalid authentication
403Insufficient permissions
404Resource not found
409Conflict (duplicate resource)
429Quota exceeded
500Internal server error
503Feature unavailable in current deployment mode