Quickstart preview
Review the proposed workflow. These commands are not runnable.
Prerequisites
No public onboarding path is documented. The proposed contract expects:
A future API organization
No concrete public onboarding path is documented.
A future API key
See Authentication for the proposed authentication shape
A future organization ID
The docs name this value but publish no dashboard URL.
Step 1: List Available Images
The proposed request would list browser images:
curl -X GET "https://{your-api-host}/orgs/{org_uuid}/api/images" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"Example response
{
"images": [
"ubuntu-20.04",
"ubuntu-22.04",
"windows-10",
"windows-11"
]
}Step 2: Create a Browser Instance
Create your first isolated browser instance:
curl -X POST "https://{your-api-host}/orgs/{org_uuid}/api/instances" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"image": "ubuntu-20.04",
"size": "small"
}'Example response
{
"instance_uuid": "1234-5678-90ab-cdef",
"status": "running",
"image": "ubuntu-20.04",
"size": "small",
"created_at": "2025-01-10T12:00:00Z",
"access_url": "https://instance.example"
}Illustrative flow: The proposed contract uses the instance_uuid. You use it to address the same instance in later requests.
Step 3: List Your Instances
List every running instance in your organization:
curl -X GET "https://{your-api-host}/orgs/{org_uuid}/api/instances" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"Step 4: Destroy an Instance
Destroy the instance when the work is done:
curl -X DELETE "https://{your-api-host}/orgs/{org_uuid}/api/instances/{instance_uuid}" \
-H "Authorization: Bearer YOUR_API_TOKEN"The proposed deletion contract returns a 204 No Content status code.
Next Steps
That is the illustrative lifecycle. No callable public endpoint or key-issuer URL is published. Review next: