Overview

Translucid provides a REST API for provisioning DRM-encrypted virtual machines with real-time browser streaming. Each session runs an isolated VM with a full browser environment, protected by screen capture prevention, forensic watermarking, and configurable security controls.

Base URL: https://api.translucid.cloud
API Version: v1
Auth: Bearer token (sk_live_...)

Authentication

All API requests require authentication via an API key passed in the Authorization header.

Request Header
Authorization: Bearer sk_live_your_api_key_here

API keys are generated from the Account page. Keys starting with sk_live_ are production keys. Keep them secret — never expose in client-side code.

Base URL

EnvironmentURL
Productionhttps://api.translucid.cloud

All endpoints are relative to the base URL. For example, creating a session is POST /sessions/v1.

Create Session

POST /sessions/v1

Provisions a new DRM-encrypted VM session. The VM boots with the specified environment, opens the startup URL(s), and returns a player URL for real-time streaming.

Request Body

ParameterTypeRequiredDescription
startupUrlstring | string[]YesURL(s) to open in the VM browser. Supports 1–50 URLs.
environment.environmentIdstringNoVM template. Default: intel-firefox-001
system.machineProfilestringNoCompute tier. Default: vcpu4-ram16-standard
system.screenWidthnumberNoScreen width in pixels. Default: 1280
system.screenHeightnumberNoScreen height in pixels. Default: 720
system.screenFpsnumberNoFrame rate. Default: 25
system.bitrateKbpsnumberNoVideo bitrate. Default: 2000
session.durationMinutesnumberNoSession length (15–360). Default: 60
session.startPolicystringNoimmediate, onDemand, or scheduled
input.micEnabledbooleanNoEnable microphone forwarding
input.webcamEnabledbooleanNoEnable webcam forwarding
security.fullscreenEnforcementbooleanNoRequire fullscreen mode. Default: true
security.acousticLeakDetectionbooleanNoDetect audio on external devices
security.spotlightModebooleanNoBlur screen except near cursor

Example Request

cURL
curl -X POST https://api.translucid.cloud/sessions/v1 \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "startupUrl": "https://example.com",
    "environment": { "environmentId": "intel-chromium-001" },
    "system": { "machineProfile": "vcpu4-ram16-standard" },
    "session": { "durationMinutes": 60 }
  }'

Response

200 OK
{
  "session": {
    "id": "a5be3cf2-...",
    "status": "provisioning",
    "playerUrl": "https://api.translucid.cloud/player/a5be3cf2-...",
    "expiresAt": "2025-02-18T12:00:00Z"
  },
  "startup_page_url": "https://api.translucid.cloud/s/a5be3cf2-..."
}

Get Session

GET /sessions/v1/:id

Retrieve details of an existing session by ID.

Response
{ "session": { "id": "...", "status": "ready", "publicIp": "3.16.10.34", ... } }

List Sessions

GET /sessions/v1

List all sessions for your organization. Returns active, ended, and terminated sessions.

Terminate Session

DELETE /sessions/v1/:id

Immediately terminates the VM and ends the session. This action cannot be undone.

Runtime Control

PATCH /sessions/v1/:id/runtime

Update security settings and input controls on a running session. Changes are pushed to connected clients instantly via WebSocket.

ParameterTypeDescription
runtimeSettings.fullscreenEnforcementbooleanToggle fullscreen requirement
runtimeSettings.acousticLeakDetectionbooleanToggle acoustic monitoring
runtimeSettings.spotlightModebooleanToggle spotlight blur
runtimeSettings.keyboardEnabledbooleanToggle keyboard input
runtimeSettings.mouseEnabledbooleanToggle mouse input
runtimeSettings.conferenceEnabledbooleanToggle video conference

Push URLs

Push new URLs to a running session's startup page. The URLs appear live with a notification sound.

PATCH /sessions/v1/:id/runtime
{
  "pushUrl": [
    { "url": "https://docs.example.com", "title": "Documentation" },
    { "url": "https://figma.com/file/..." }
  ]
}

Environments

Each environment is a pre-built VM template with a specific OS, browser, and DRM configuration.

IDBrowserDRMWebcam
intel-firefox-001FirefoxYesYes
intel-chromium-001ChromiumYesYes
intel-xfce-prod-001XFCE DesktopYesYes

Machine Profiles

Choose a compute tier based on your workload requirements.

ProfilevCPURAMUse Case
vcpu2-ram4-economy24 GBLight browsing, document viewing
vcpu2-ram8-standard28 GBStandard web applications
vcpu4-ram16-standard416 GBRich web apps, video conferencing
vcpu8-ram32-performance832 GBHeavy workloads, IDEs, design tools
vcpu4-ram16-gpu4 + GPU16 GB3D rendering, GPU-accelerated tasks

Pricing

Sessions are billed per minute of active VM time. Pricing varies by machine profile.

ProfilePer MinutePer Hour
Economy (2 vCPU / 4 GB)4 credits240 credits
Standard (2 vCPU / 8 GB)6 credits360 credits
Standard Plus (4 vCPU / 16 GB)12 credits720 credits
Performance (8 vCPU / 32 GB)16 credits960 credits
Graphics (4 vCPU / 16 GB + GPU)20 credits1,200 credits

Prices are estimates and may vary. Contact sales for volume discounts.

Error Codes

StatusCodeDescription
400validation_errorInvalid request parameters
401unauthorizedMissing or invalid API key
404not_foundSession not found
409conflictSession already terminated
429rate_limitedToo many requests
500internal_errorServer error — retry with backoff
Error Response Format
{ "error": "Description of what went wrong", "code": "error_code" }