Compute Client - Namespace Documentation

Use createComputeClient() to configure authentication and select the regional API endpoint. The returned client provides access to the compute services: instances, commands, storage, usage, observability, and management.

`createComputeClient()`

Create a client for the compute services. The client loads credentials when it first makes an authenticated request.

Example

import { createComputeClient } from "@namespacelabs/sdk/api/compute";

const client = createComputeClient();

/*  Work with the compute client here */

Select another region or provide an explicit token source:

import { loadUserToken } from "@namespacelabs/sdk/auth";
import { createComputeClient } from "@namespacelabs/sdk/api/compute";

const client = createComputeClient({
  region: "eu",
  tokenSource: loadUserToken,
});

API reference

createComputeClient(opts?: ComputeClientOpts): ComputeClient

Arguments and options

ComputeClientOpts

Options used to configure the client.

Hide properties

TokenSourceInput

Provides API tokens for Namespace requests. Defaults to the Namespace workload token when available, then falls back to the local user token.

string

default:"us"

The regional API endpoint used by the default transport, such as us or eu. The client connects to https://<region>.compute.namespaceapis.com.

Transport

A fully configured Connect transport for compute API requests. When provided, region and tokenSource are ignored, so the transport must supply its own authentication.

Return value

createComputeClient() returns a ComputeClient. In examples, this object is assigned to the client variable.

`ComputeClient`

A ComputeClient exposes one service client per compute API. All six share the transport created with the client, so they use the same region and credentials.

Example

import { createComputeClient } from "@namespacelabs/sdk/api/compute";

const client = createComputeClient();
const instances = await client.compute.listInstances({});

API reference

interface ComputeClient {
  compute: Client<typeof ComputeService>;
  command: Client<typeof CommandService>;
  storage: Client<typeof StorageService>;
  usage: Client<typeof UsageService>;
  observability: Client<typeof ObservabilityService>;
  management: Client<typeof ManagementService>;
}

Each service client exposes its RPCs as camelCase methods. The table below lists what each service covers.

Property	Covers
`client.compute`	The instance lifecycle, and access and networking for ingresses, SSH, VNC, Kubernetes, and workspace network configuration.
`client.command`	Running commands on an instance with `runCommand` and `runCommandSync`.
`client.storage`	Cache volumes and persistent volumes, including listing, describing, and destroying volumes and snapshots.
`client.usage`	Usage reporting with `getUsage`, `getVolumeUsage`, `getArtifactUsage`, `getUsageTimeSeries`, `getConcurrency`, and `generateReport`.
`client.observability`	Instance logs with `streamInstanceLogs` and `fetchInstanceLogs`, and egress records with `fetchInstanceEgress`.
`client.management`	Partner-only. Registers and reads the known images Namespace optimizes for fast boot, with `setKnownImages` and `getKnownImages`. These methods require a partner OIDC token trusted by Namespace, not the user or workload credentials described under Authentication.

Request and response types for every method are documented in the compute API reference. These pages cover the methods most applications need. The service clients expose every generated RPC, including internal ones such as optimizeImage, so use the generated API reference for anything not documented here.

ComputeClient has no close() method.

Explore the APIs

Create and manage instances

Create, wait for, inspect, list, extend, suspend, wake, and destroy instances.

Access and networking

Expose ingresses and read SSH, VNC, and Kubernetes configuration.

Authenticate with Namespace

Configure credentials for local development and automated workloads.

Get started with Compute

Create your first instance with the TypeScript SDK.

Compute platform

Learn about platforms, machine shapes, storage, and instance access.

​createComputeClient()

​Example

​API reference

​Arguments and options

​Return value

​ComputeClient

​Example

​API reference

​Explore the APIs

Create and manage instances

Access and networking

Authenticate with Namespace

​Related documentation

Get started with Compute

Compute platform

`createComputeClient()`

Example

API reference

Arguments and options

Return value

`ComputeClient`

Example

API reference

Explore the APIs

Related documentation