computers

Provision a new cloud computer (optionally from a template via template_ref)

Changed on

With no size the computer is 4 GB RAM and 1 vCPU. A ram with no cpu gets that size’s vCPU (8 GB: 2, 16 GB: 4, 32 GB: 6, 64 GB: 8). An explicit cpu is used as given; cpu 16 passes the value check and is refused with 403 PER_COMPUTER_CPU_CAP (8 is the most one computer runs). With template_ref and no cpu/ram the template’s own size applies, with at least the vCPU of its RAM’s size (an 8 GB template launches with 2). vCPU is an account pool shared by the owner’s computers. A computer past XL (more than 6 vCPU or 32 GB, so 2XL: 8 vCPU, 64 GB), asked for or brought by a template, is set up on request on every plan: 403 CONTACT_US_FOR_SIZE with max_cpu and max_ram_gb, unless the workspace owner is on Enterprise or has a negotiated plan that goes past XL (GET /api/billing/compute-limits past_xl_allowed). Clones and hourly launches of 2XL follow the same rule. ends_in_hours (1 to 720) gives a Linux or Windows computer an end: when it is up the computer is deleted, running or not, with everything on it. To keep a computer, leave out the end (omitted or null: it never ends). on_end is not a choice: "delete" is accepted and changes nothing, and any other value ("stop" included) is 400 INVALID_ENDS. The 201 carries ends_at and on_end (read only). An hourly computer (billing_mode hourly) with an end prepays its whole run at launch: the running rate times the hours, held from the same credit hourly draws on, so it is never stopped for lack of credit before its end; what it does not use goes back when it stops, is deleted, is kept (ends_at null) or its end moves. A prepay always leaves an hour of the owner’s other hourly computers billed by the hour. A Start bills by the hour, unless it sets an end (POST /api/computers/{id}/start ends_in_hours): that run is prepaid once it is running. Moving the end prepays again. The 201 then carries prepaid_until (its end) and prepaid_cents. Send an Idempotency-Key header (any printable key, 1 to 255 characters, such as a UUID or "job-42") with an hourly launch so a retry answers with the computer the first request made instead of launching and billing a second one; the key is your account’s, and the same key with another size, OS, name or workspace is 409 HOURLY_REQUEST_CONFLICT. A key that is not a UUID names one launch per UTC day (a launch from the day before stays its own for an hour, unless deleted); after that the same key launches a new computer. A key that is not 1 to 255 printable characters is ignored.

post/api/computers

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Request body

workspace_idstring required

The workspace to create it in (project_id is accepted too).

namestring required
os'linux' | 'windows' | 'macos' | 'android' | 'ios'
ram4 | 8 | 10 | 16 | 32 | 64

GB. macOS: 10 only, the default when omitted; anything else is refused with 400 MACOS_RAM_FIXED (contact us for more). Other systems: 4, 8, 16, 32 or 64 (default 4).

cpu0.5 | 1 | 2 | 4 | 6 | 8 | 16

vCPU. Omitted: 1 for 4 GB, else the vCPU of the ram’s size (8 GB: 2, 16 GB: 4, 32 GB: 6, 64 GB: 8). Above 6 (or ram 64) is set up on request: 403 CONTACT_US_FOR_SIZE unless the owner is on Enterprise or a negotiated plan past XL. Above 8 is refused with 403 PER_COMPUTER_CPU_CAP. macOS ignores it: the Mac sets the vCPU (8 on a Mac mini M4, 10 on an M6), so omit it.

disk_size_gbinteger

Omitted: the template’s disk, else the plan’s birth size.

template_refstring

namespace/name@version

gpu'2q' | '4q'

Linux only.

resolutionstring

WIDTHxHEIGHTxDEPTH, e.g. 1280x720x24.

ends_in_hoursinteger nullable

Linux and Windows only. When its time is up the computer is deleted, with everything on it. Omitted or null: it never ends, the way to keep a computer. An hourly launch prepays the whole run from credit (402 with needed_cents and available_cents when it cannot).

on_end'delete' | 'null' nullable

Not a choice: a computer with an end is deleted when its time is up, running or not, with everything on it. "delete" is accepted and changes nothing; omitted or null is the same. Any other value, "stop" included, is 400 INVALID_ENDS: "A computer with an end is deleted when its time is up. To keep a computer, leave out the end." On a computer (GET, the listing, and the create, PATCH, Start and Resume answers) on_end is read only: "delete", "stop" for a computer whose end was set before this rule (stopped then, and deleted 7 days later unless it is started), or null with no end.

billing_mode'hourly' | 'plan'

How the computer is paid for. "hourly": by the hour from the account’s credit, no quote needed (a Medium Linux computer on a Free account; any self-serve size on a paid one, for what the plan cannot take). "plan": on the paid plan. Omitted: on a Free account a create from an API key or an MCP sign-in runs by the hour from credit, as "hourly" does; a paid account’s uses its plan, and past the plan’s vCPU or RAM room or its computer count, from a key with full access or Billing write, runs by the hour when the credit covers it. Hourly launches are idempotent: send an Idempotency-Key (any key up to 255 characters, such as a UUID or job-42) and a retry returns the same computer.

Response

Created computer.

Changes

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the non-success response with the status