Skip to content

feat(docs): add REST API reference for CUA Cloud #972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarinali wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(docs): add REST API reference for CUA Cloud #972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c50c73d
docs: add REST API reference for CUA Cloud
sarinali Feb 2, 2026
9c8be5e
docs: add icon to REST API sidebar entry
sarinali Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/content/docs/cua/reference/computer-sdk/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1023,26 +1023,30 @@ resp = await provider.restart_vm("my-vm-name")

### HTTP API

You can also manage sandboxes via HTTP:
You can also manage sandboxes via the REST API:

```bash
# List sandboxes
curl -H "Authorization: Bearer $CUA_API_KEY" \
"https://api.cua.ai/v1/vms"

# Create sandbox
curl -X POST -H "Authorization: Bearer $CUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"os": "linux", "configuration": "small", "region": "north-america"}' \
"https://api.cua.ai/v1/vms"

# Start sandbox
curl -X POST -H "Authorization: Bearer $CUA_API_KEY" \
"https://api.cua.ai/v1/vms/my-vm-name/start"

# Stop sandbox
curl -X POST -H "Authorization: Bearer $CUA_API_KEY" \
"https://api.cua.ai/v1/vms/my-vm-name/stop"

# Restart sandbox
curl -X POST -H "Authorization: Bearer $CUA_API_KEY" \
"https://api.cua.ai/v1/vms/my-vm-name/restart"
```

For the complete HTTP API reference, see the [REST API Reference](/cua/reference/rest-api).

---

## Types
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/cua/reference/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"title": "Reference",
"description": "SDK and CLI API reference",
"icon": "FileText",
"pages": ["desktop-sandbox", "computer-sdk", "agent-sdk", "mcp-server", "cloud-cli"]
"pages": ["desktop-sandbox", "computer-sdk", "agent-sdk", "mcp-server", "cloud-cli", "rest-api"]
}
Loading