2026-11-04
▼ ▲ colaboratory.runtimes.get
HTTP Method : GET
Flat Path : v1beta/runtimes/{runtimesId}
Parameters :
name
Required : Yes
Pattern : ^runtimes/[^/]+$
Location : path
Description : Required. The name of the runtime to retrieve. Format: `runtimes/{runtime_id}`.
Type : string
Parameter Order : name
Scopes :
Path : v1beta/{+name}
Description : Gets a Colab runtime assigned to the requesting user.
▼ ▲ colaboratory.runtimes.create
HTTP Method : POST
Description : Creates a Colab runtime assignment. When runtime creation is refused with a [`FAILED_PRECONDITION` (code: 9)](https://github.com/googleapis/googleapis/blob/437254f595a380cd9323111700ce0fcf9d6d2c21/google/rpc/code.proto#L128) error, a more specific error reason will be returned in the details of the Operation error wrapped in google.rpc.ErrorInfo. A requests-per-minute-per-project and a requests-per-minute-per-user quota are enforced on this API. To see the exact limit your project is subject to, after you enable the Colab API, view it in your project's [Quotas & System Limits](https://console.cloud.google.com/apis/api/colaboratory.googleapis.com/quotas) page. Note that there is no usage reporting on the per-user limit and it is not overridable at the individual user level.
Parameters :
requestId
Description : Optional. A unique identifier for this request. This request is only idempotent if a `request_id` is provided. See [AIP-155](https://google.aip.dev/155) for more details. If provided, the request ID must be in UUID4 format per https://linter.aip.dev/155/request-id-format.
Type : string
Location : query
runtimeId
Location : query
Description : Optional. A unique identifier for the runtime. If not supplied, a random ID will be generated. If a runtime with the given ID owned by the requesting user already exists, a completed Operation with an [`ALREADY_EXISTS` (code: 6)](https://github.com/googleapis/googleapis/blob/437254f595a380cd9323111700ce0fcf9d6d2c21/google/rpc/code.proto#L84) error will be returned. See [AIP-133](https://google.aip.dev/133#user-specified-ids) for more details. The ID must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034), specifically: - 1 to 63 characters - Lower-case letters, digits, and hyphens - Start with a letter - End with a letter or digit
Type : string
Scopes : https://www.googleapis.com/auth/colaboratory
Path : v1beta/runtimes
Flat Path : v1beta/runtimes
▼ ▲ colaboratory.runtimes.delete
Path : v1beta/{+name}
Parameter Order : name
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/colaboratory
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the runtime to unassign. Format: `runtimes/{runtime_id}`.
Pattern : ^runtimes/[^/]+$
Location : path
allowMissing
Description : Optional. If set to `true`, and the runtime is not found, the request will succeed but no action will be taken on the server.
Type : boolean
Location : query
Description : Deletes a Colab runtime assignment. **Best Practices:** - Avoid deleting runtimes unless necessary. Reuse runtimes for efficiency. - Create a new Jupyter session within an existing runtime for state isolation.
Flat Path : v1beta/runtimes/{runtimesId}
▼ ▲ colaboratory.runtimes.list
Path : v1beta/runtimes
Description : Lists Colab runtimes assigned to the requesting user.
HTTP Method : GET
Flat Path : v1beta/runtimes
Scopes :
▼ ▲ colaboratory.getSubscription
Description : Gets the subscription of the requesting user.
HTTP Method : GET
Scopes :
Parameter Order : name
Path : v1beta/{+name}
Parameters :
name
Required : Yes
Type : string
Pattern : ^subscription$
Location : path
Description : Required. The name of the subscription to retrieve. The only valid value is "subscription".
Flat Path : v1beta/subscription
▼ ▲ colaboratory.runtimespecs.list
Description : Lists available Colab runtime specs and their eligibility to the requesting user.
Flat Path : v1beta/runtimespecs
Scopes :
Path : v1beta/runtimespecs
HTTP Method : GET