OneOS Docs
Genesis 0.1.12 Console

API reference

Rigs

Your desktops: list them.

Operations
1
Base path
https://os.one.ml/api/v1/rigs
Scopes
rigs:read
API keys
1 refused to API keys
SDK
genesis.call('rigs_listRigs', …) · helpers under genesis.rigs
CLI
genesis rigs
MCP
1 tools

Operations

OperationEndpointAPI key
List your Rigs (desktops)GETAPI keys refused

Rigs

List your Rigs (desktops)

GET/v1/rigs

rigs:readAPI keys refusedrigs_listRigs

Rigs in the selected organization and project. Needs rigs:read (or rigs:write). An inventory of 100 or more is refused rather than shown incomplete.

Responses

  • 200Rigs in the selected project
    Response fields
    • product"rigs"required
    • instancesobject[]required
    • instances[].[].idstringrequired
    • instances[].[].omegaDeploymentIdstringrequired
    • instances[].[].namestringrequired
    • instances[].[].kindstringrequired

      desktop (Rigs), browser (Panes) or sandbox (Shells)

    • instances[].[].statusstringrequired
    • instances[].[].stagestringrequired

      queued, placed, running, failed, unknown or another producer stage

    • instances[].[].detailUrlstring
    • instances[].[].regionstring | null
    • instances[].[].tierstring | null
    • instances[].[].runtimestring | null
    • instances[].[].createdAtstring | null
    • instances[].[].updatedAtstring | null
  • 403RIGS_HUMAN_REQUIRED, RIGS_READ_PERMISSION_REQUIRED, RIGS_CONTEXT_REQUIRED or RIGS_CONTEXT_NOT_ADMITTED
  • 409RIGS_CONTEXT_CHANGED (selection changed during the read)
  • 502RIGS_READ_REFUSED, RIGS_INVALID_RESPONSE or RIGS_INVALID_OR_INCOMPLETE_INVENTORY
  • 503Rigs unavailable
  • 4xx 5xxThe error envelope.
curl "https://os.one.ml/api/v1/rigs" \
  -H "Authorization: Bearer $GENESIS_API_KEY"

One Superintelligence, Inc. · Built from Genesis 0.1.12 and the live gateway on 2026-10-20. Support