API reference
Devices
GET
OK
application/json- response
keys*array<>curl -X GET 'https://engine.keko.run/v1/dock/keys'Example Response
{ "keys": [ { "id": "string", "publicKey": "string", "endorsedBy": { "id": "string", "signature": "string" } } ]}GET
bearerheader
AuthorizationBearer <token>OK
application/json- response
devices*array<>curl -X GET 'https://engine.keko.run/v1/devices'Example Response
{ "devices": [ { "id": "string", "name": "string", "online": true, "kind": "cloud", "hostname": "string", "os": "string", "arch": "string", "info": { "name": "string", "hostname": "string", "os": "string", "arch": "string", "folders": [ "string" ], "home": "string", "version": "string", "hardware": { "type": "laptop", "model": "string", "chip": "string", "cores": 1, "memoryBytes": 1, "system": "string" }, "capabilities": { "arch": "string", "git": "string", "gh": "string", "node": "string", "bun": "string", "python": "string", "docker": "string", "browser": "string", "desktop": "string", "desktopPort": 1, "computer": [ "string" ], "recording": "string", "previews": true, "diskFreeBytes": 0, "memoryFreeBytes": 0, "memoryLimitBytes": 0 }, "gitCredentials": "own", "app": "mac", "variables": true }, "lastSeenAt": 0, "createdAt": 0, "maxThreads": 1, "userId": "string" } ]}POST
bearerheader
AuthorizationBearer <token>application/json- body
name*stringDefault
""hostname?stringLength
length <= 255os?stringLength
length <= 32arch?stringLength
length <= 32OK
application/json- response
device*pairingToken*stringcurl -X POST 'https://engine.keko.run/v1/devices' \ -H 'Content-Type: application/json' \ -d '{ "name": ""}'Example Response
{ "device": { "id": "string", "name": "string", "online": true, "kind": "cloud", "hostname": "string", "os": "string", "arch": "string", "info": { "name": "string", "hostname": "string", "os": "string", "arch": "string", "folders": [ "string" ], "home": "string", "version": "string", "hardware": { "type": "laptop", "model": "string", "chip": "string", "cores": 1, "memoryBytes": 1, "system": "string" }, "capabilities": { "arch": "string", "git": "string", "gh": "string", "node": "string", "bun": "string", "python": "string", "docker": "string", "browser": "string", "desktop": "string", "desktopPort": 1, "computer": [ "string" ], "recording": "string", "previews": true, "diskFreeBytes": 0, "memoryFreeBytes": 0, "memoryLimitBytes": 0 }, "gitCredentials": "own", "app": "mac", "variables": true }, "lastSeenAt": 0, "createdAt": 0, "maxThreads": 1 }, "pairingToken": "string"}POST
bearerheader
AuthorizationBearer <token>deviceId*stringOK
application/json- response
device*pairingToken*stringcurl -X POST 'https://engine.keko.run/v1/devices/string/pairing'Example Response
{ "device": { "id": "string", "name": "string", "online": true, "kind": "cloud", "hostname": "string", "os": "string", "arch": "string", "info": { "name": "string", "hostname": "string", "os": "string", "arch": "string", "folders": [ "string" ], "home": "string", "version": "string", "hardware": { "type": "laptop", "model": "string", "chip": "string", "cores": 1, "memoryBytes": 1, "system": "string" }, "capabilities": { "arch": "string", "git": "string", "gh": "string", "node": "string", "bun": "string", "python": "string", "docker": "string", "browser": "string", "desktop": "string", "desktopPort": 1, "computer": [ "string" ], "recording": "string", "previews": true, "diskFreeBytes": 0, "memoryFreeBytes": 0, "memoryLimitBytes": 0 }, "gitCredentials": "own", "app": "mac", "variables": true }, "lastSeenAt": 0, "createdAt": 0, "maxThreads": 1 }, "pairingToken": "string"}PATCH
bearerheader
AuthorizationBearer <token>deviceId*stringapplication/json- body
name?stringLength
1 <= length <= 80maxThreads?|nullOK
application/json- response
device*curl -X PATCH 'https://engine.keko.run/v1/devices/string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "device": { "id": "string", "name": "string", "online": true, "kind": "cloud", "hostname": "string", "os": "string", "arch": "string", "info": { "name": "string", "hostname": "string", "os": "string", "arch": "string", "folders": [ "string" ], "home": "string", "version": "string", "hardware": { "type": "laptop", "model": "string", "chip": "string", "cores": 1, "memoryBytes": 1, "system": "string" }, "capabilities": { "arch": "string", "git": "string", "gh": "string", "node": "string", "bun": "string", "python": "string", "docker": "string", "browser": "string", "desktop": "string", "desktopPort": 1, "computer": [ "string" ], "recording": "string", "previews": true, "diskFreeBytes": 0, "memoryFreeBytes": 0, "memoryLimitBytes": 0 }, "gitCredentials": "own", "app": "mac", "variables": true }, "lastSeenAt": 0, "createdAt": 0, "maxThreads": 1, "userId": "string" }}DELETE
bearerheader
AuthorizationBearer <token>deviceId*stringOK
application/json- response
ok*booleancurl -X DELETE 'https://engine.keko.run/v1/devices/string'Example Response
{ "ok": true}GET
bearerheader
AuthorizationBearer <token>OK
application/json- response
available*booleanoutage?fallback*suggestedDeviceId?stringwaiting*array<>curl -X GET 'https://engine.keko.run/v1/cloud/status'Example Response
{ "available": true, "outage": { "reason": "starts", "message": "string", "until": 0 }, "fallback": { "mode": "ask", "deviceId": "string" }, "suggestedDeviceId": "string", "waiting": [ { "id": "string", "title": "string", "projectName": "string", "createdAt": 0, "model": { "provider": "string", "id": "string" }, "permissionMode": "ask", "ownerId": "string", "message": "string", "until": 0, "firstMessage": "string", "failed": "string", "starting": true } ]}PUT
bearerheader
AuthorizationBearer <token>application/json- body
mode*stringValue in
"ask""server""wait"deviceId?stringLength
1 <= lengthOK
application/json- response
available*booleanoutage?fallback*suggestedDeviceId?stringwaiting*array<>curl -X PUT 'https://engine.keko.run/v1/cloud/fallback' \ -H 'Content-Type: application/json' \ -d '{ "mode": "ask"}'Example Response
{ "available": true, "outage": { "reason": "starts", "message": "string", "until": 0 }, "fallback": { "mode": "ask", "deviceId": "string" }, "suggestedDeviceId": "string", "waiting": [ { "id": "string", "title": "string", "projectName": "string", "createdAt": 0, "model": { "provider": "string", "id": "string" }, "permissionMode": "ask", "ownerId": "string", "message": "string", "until": 0, "firstMessage": "string", "failed": "string", "starting": true } ]}GET
Control messages as JSON text frames, channel bytes as binary frames (a u32 channel id, then the bytes). Closes with DOCK_CLOSE codes: 4003 refused, 4002 update required, 4000 violation, 1012 restarting. A token that matches no device gets a 401 with x-keko-dock: refused, on the upgrade and on a plain GET (which answers 426 for a good token); a removed device’s token also gets x-keko-dock-reason: Device removed.
bearerheader
AuthorizationBearer <token>Switches to a WebSocket
curl -X GET 'https://engine.keko.run/v1/dock'Example Response
Empty