SDK reference

The Segal TypeScript SDK is a thin, fully-typed client over the REST API. Its surface is generated from the same OpenAPI 3.1.0 document as the API reference, so every method maps one-to-one to an endpoint and never drifts.

Install

npm install @segal/sdk

Initialize

Construct the client with a scoped sk_segal_ API key. Read it from the environment — never hard-code a key.

import { Segal } from "@segal/sdk";

const segal = new Segal({ apiKey: process.env.SEGAL_API_KEY });

Errors

Failed calls throw a SegalError carrying the same envelope as the REST API — type, code, message, and request_id. See Errors.

import { Segal, SegalError } from "@segal/sdk";

try {
  await segal.domains.registerDomain({ name: "acme.dev" });
} catch (err) {
  if (err instanceof SegalError) {
    console.error(err.code, err.requestId);
  }
}

Service clients

Each service is a namespaced client. Methods are named for their operationId and take a single typed argument object.