POST
/
windows
/
start
curl --request POST \
  --url https://api.launchskylight.com/windows/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "api_key": "<string>",
  "timeout_minutes": 123
}'
{
  "instance_id": "<string>",
  "livestream_url": "<string>",
  "message": "<string>",
  "state": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key authentication

Body

application/json
​
api_key
string | null

Optional API key for authentication

​
timeout_minutes
integer | null
default:60

Timeout in minutes before instance auto-termination

Response

200
application/json
Instance started successfully
​
instance_id
string
required

Unique identifier of the created instance

​
message
string
required

Human-readable status message

Example:

"Instance ready to use"

​
livestream_url
string
required

URL to livestream the instance

Example:

"launchskylight.com/embed/i-123456"

​
state
string
required

State of the instance (running, pending, hibernated, terminated)

Example:

"running"