API reference
Keko Cloud
GET
bearerheader
AuthorizationBearer <token>OK
application/json- response
machines*array<>curl -X GET 'https://engine.keko.run/v1/machines'Example Response
{ "machines": [ { "id": "string", "provider": "string", "providerId": "string", "key": "string", "purpose": "thread", "projectId": "string", "userId": "string", "snapshot": "string", "image": "string", "deviceId": "string", "state": "creating", "size": "small", "region": "string", "threadIds": [ "string" ], "leaseUntil": 0, "lastAgentActivityAt": 0, "lastHumanActivityAt": 0, "createdAt": 0, "updatedAt": 0, "stoppedAt": 0, "clearedAt": 0, "prewarmedUntil": 0, "automatic": true, "error": "string", "status": { "phase": "starting", "label": "string", "percent": 0, "reason": "string", "at": 0, "source": "engine" }, "previews": [ { "port": 0, "name": "", "url": "string", "access": "private", "state": "live", "firstSeenAt": 0, "lastSeenAt": 0 } ], "tunnels": [ { "id": "string", "threadId": "string", "fromDeviceId": "string", "localPort": 0, "remotePort": 0, "state": "requested", "requestedAt": 0, "approvedAt": 0, "error": "string" } ], "mirror": { "at": 0, "terminals": [ { "title": "string", "status": "string", "tail": "string" } ] }, "forkedFrom": { "threadId": "string", "machineId": "string", "turn": 0, "entryId": 0 } } ]}GET
bearerheader
AuthorizationBearer <token>OK
application/json- response
settings*curl -X GET 'https://engine.keko.run/v1/machines/settings'Example Response
{ "settings": { "agentIdleMs": 0, "humanIdleMs": 0, "leaseSeconds": 0, "renewBelowMs": 0, "tickMs": 0, "size": "small", "region": "string", "prewarmTtlMs": 0, "maxPrewarmed": 0, "bootTimeoutMs": 0, "autoSnapshot": true, "clearAfterDays": 0, "stopGraceMs": 0 }}PATCH
bearerheader
AuthorizationBearer <token>application/json- body
agentIdleMs?numberRange
0 < valuehumanIdleMs?numberRange
0 < valueleaseSeconds?numberRange
0 < valuerenewBelowMs?numberRange
0 < valuetickMs?numberRange
0 < valuesize?stringValue in
"small""default""large""xlarge"prewarmTtlMs?numberRange
0 < valuemaxPrewarmed?numberRange
0 <= valuebootTimeoutMs?numberRange
0 < valueautoSnapshot?booleanclearAfterDays?numberRange
0 <= valuestopGraceMs?numberRange
0 <= valueOK
application/json- response
settings*curl -X PATCH 'https://engine.keko.run/v1/machines/settings' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "settings": { "agentIdleMs": 0, "humanIdleMs": 0, "leaseSeconds": 0, "renewBelowMs": 0, "tickMs": 0, "size": "small", "region": "string", "prewarmTtlMs": 0, "maxPrewarmed": 0, "bootTimeoutMs": 0, "autoSnapshot": true, "clearAfterDays": 0, "stopGraceMs": 0 }}POST
bearerheader
AuthorizationBearer <token>application/json- body
projectId*stringDefault
""repoUrl?stringbranch?stringtestBranch?stringLength
1 <= length <= 255OK
application/json- response
machine*|nullcurl -X POST 'https://engine.keko.run/v1/machines/prewarm' \ -H 'Content-Type: application/json' \ -d '{ "projectId": ""}'Example Response
{ "machine": { "id": "string", "provider": "string", "providerId": "string", "key": "string", "purpose": "thread", "projectId": "string", "userId": "string", "snapshot": "string", "image": "string", "deviceId": "string", "state": "creating", "size": "small", "region": "string", "threadIds": [ "string" ], "leaseUntil": 0, "lastAgentActivityAt": 0, "lastHumanActivityAt": 0, "createdAt": 0, "updatedAt": 0, "stoppedAt": 0, "clearedAt": 0, "prewarmedUntil": 0, "automatic": true, "error": "string", "status": { "phase": "starting", "label": "string", "percent": 0, "reason": "string", "at": 0, "source": "engine" }, "previews": [ { "port": 0, "name": "", "url": "string", "access": "private", "state": "live", "firstSeenAt": 0, "lastSeenAt": 0 } ], "tunnels": [ { "id": "string", "threadId": "string", "fromDeviceId": "string", "localPort": 0, "remotePort": 0, "state": "requested", "requestedAt": 0, "approvedAt": 0, "error": "string" } ], "mirror": { "at": 0, "terminals": [ { "title": "string", "status": "string", "tail": "string" } ] }, "forkedFrom": { "threadId": "string", "machineId": "string", "turn": 0, "entryId": 0 } }}POST
bearerheader
AuthorizationBearer <token>machineId*stringOK
application/json- response
machine*curl -X POST 'https://engine.keko.run/v1/machines/string/stop'Example Response
{ "machine": { "id": "string", "provider": "string", "providerId": "string", "key": "string", "purpose": "thread", "projectId": "string", "userId": "string", "snapshot": "string", "image": "string", "deviceId": "string", "state": "creating", "size": "small", "region": "string", "threadIds": [ "string" ], "leaseUntil": 0, "lastAgentActivityAt": 0, "lastHumanActivityAt": 0, "createdAt": 0, "updatedAt": 0, "stoppedAt": 0, "clearedAt": 0, "prewarmedUntil": 0, "automatic": true, "error": "string", "status": { "phase": "starting", "label": "string", "percent": 0, "reason": "string", "at": 0, "source": "engine" }, "previews": [ { "port": 0, "name": "", "url": "string", "access": "private", "state": "live", "firstSeenAt": 0, "lastSeenAt": 0 } ], "tunnels": [ { "id": "string", "threadId": "string", "fromDeviceId": "string", "localPort": 0, "remotePort": 0, "state": "requested", "requestedAt": 0, "approvedAt": 0, "error": "string" } ], "mirror": { "at": 0, "terminals": [ { "title": "string", "status": "string", "tail": "string" } ] }, "forkedFrom": { "threadId": "string", "machineId": "string", "turn": 0, "entryId": 0 } }}GET
bearerheader
AuthorizationBearer <token>projectId?stringOK
application/json- response
snapshots*array<>curl -X GET 'https://engine.keko.run/v1/snapshots'Example Response
{ "snapshots": [ { "userId": "string", "projectId": "string", "name": "string", "state": "building", "fingerprint": { "lockfiles": "string", "setup": "string", "image": "string" }, "createdAt": 0, "readyAt": 0, "error": "string", "machineId": "string", "test": true, "branch": "string", "source": "file", "setupCommit": "string", "setupError": "string", "logs": [ { "phase": "initialize", "command": "string", "status": "done", "code": 0, "ms": 0, "output": "string", "failingLine": "string" } ] } ]}POST
bearerheader
AuthorizationBearer <token>application/json- body
projectId*stringDefault
""repoUrl?stringbranch?stringtestBranch?stringLength
1 <= length <= 255OK
application/json- response
snapshot*|nullcurl -X POST 'https://engine.keko.run/v1/snapshots' \ -H 'Content-Type: application/json' \ -d '{ "projectId": ""}'Example Response
{ "snapshot": { "userId": "string", "projectId": "string", "name": "string", "state": "building", "fingerprint": { "lockfiles": "string", "setup": "string", "image": "string" }, "createdAt": 0, "readyAt": 0, "error": "string", "machineId": "string", "test": true, "branch": "string", "source": "file", "setupCommit": "string", "setupError": "string", "logs": [ { "phase": "initialize", "command": "string", "status": "done", "code": 0, "ms": 0, "output": "string", "failingLine": "string" } ] }}