For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

DoTs is DigitalOcean’s official TypeScript client library for the DigitalOcean API, which lets you programmatically manage Droplets, Kubernetes clusters, databases, and other DigitalOcean resources with conventional HTTP requests. It is generated from the DigitalOcean OpenAPI specification.

Installation

Prerequisites: Node.js 18+, TypeScript 5+, and "type": "module" in your package.json.

Install the package:

npm i @digitalocean/dots

Quickstart

Authenticate with a personal access token. Set your token as an environment variable before running the example:

export DIGITALOCEAN_TOKEN=<your-api-token>

Create a client and list your Droplets:

import {
  createDigitalOceanClient,
  DigitalOceanApiKeyAuthenticationProvider,
  FetchRequestAdapter,
} from "@digitalocean/dots";

const token = process.env.DIGITALOCEAN_TOKEN;
const authProvider = new DigitalOceanApiKeyAuthenticationProvider(token!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const resp = await client.v2.droplets.get();
if (resp?.droplets) {
  for (const droplet of resp.droplets) {
    console.log(`${droplet.id}: ${droplet.name}`);
  }
}

For serverless inference, use InferenceClient from @digitalocean/dots. See the Inference how-tos for examples.

More Information

DigitalOcean DoTs TypeScript Library Reference

Reference for the resources and methods in DoTs, the official TypeScript client for the DigitalOcean API.

GitHub - digitalocean/dots

The DoTs GitHub repository.

SDK and Client Libraries

All official and community client libraries.