Skip to main content
GET
Get computer operation
Use the poll_url returned by an asynchronous start or stop. Authenticate each poll with the same API key. The response contains id, desktop_id (the computer UUID), action (start or stop), status, result, error, created_at, updated_at, and poll_url. status is queued, running, succeeded, failed, or needs_review. Poll every two seconds while queued or running; the response carries Retry-After: 2. A successful operation has a result such as { "success": true }; failed operations have an error containing error, code, and status. needs_review means the host’s answer was lost and the result is uncertain. Orgo checks the computer and settles the operation as succeeded or failed on its own, within about two hours at most. A second start or stop returns 409 until then, to avoid repeating an action that may already have completed. Operations are scoped to their computer and workspace. A missing or invalid API key returns 401 with { "error": "Authentication required" } or { "error": "Invalid API key" }. An unknown operation, an operationId that is not a UUID, or one belonging to another computer returns 404 with { "error": "Operation not found" }. An unknown computer returns 404 with { "error": "Desktop not found" }, and a workspace you cannot access returns 403. A view-only member is also refused with 403 and { "error": "This workspace is view-only. Ask the owner for write access (workspace_read_only)." }: polling an operation counts as a write in the access check. A trial computer whose trial has ended returns 402 with { "error": "Choose a plan to continue." }. If Orgo cannot verify the credential because of a server-side fault, such as a database outage, the poll returns 503 with { "error": "Service temporarily unavailable. …" } and Retry-After: 5. Retry after that delay; do not rotate the key.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer UUID or instance ID.

operationId
string<uuid>
required

Response

Operation state.

id
string<uuid>
desktop_id
string<uuid>
action
enum<string>
Available options:
start,
stop
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
needs_review
result
object | null

On success, such as { "success": true }.

error
object | null

On failure: error, code, and status.

created_at
string<date-time>
updated_at
string<date-time>
poll_url
string