Google

Colab API

The Colab API lets you programmatically manage Colab runtimes.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Colab API lets you programmatically manage Colab runtimes.

Endpoints 3

operations

  • GETGets the latest state of a long-running operation/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • GETLists operations that match the specified filter in the request/v1/operations?pageSize=0&pageToken=stringLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
  • GETWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest…/v1/:name:wait?timeout=stringWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done,…

API details

Base URL
https://colaboratory.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
3 operations on 3 pathsGET 3
Main resources
operations 3
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Colab API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Colab API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Colab API?

The Colab API lets you programmatically manage Colab runtimes. It is listed under Developer tools and has 3 endpoints.

Who publishes the Colab API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Colab API?

Requests go to https://colaboratory.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Colab API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Colab API have?

3 operations on 3 paths (3 GET). The largest groups are operations.

Is forking the Colab API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.