SETUP GUIDE

AntOps TypeScript SDK

Call the production API from TypeScript through the published client and a workspace API key.

Before you start

  • Node.js and npm
  • A workspace API key stored in an environment or secret manager

Setup

  1. Install the current package with npm install @antops/[email protected].
  2. Provide ANTOPS_API_KEY to the server-side runtime.
  3. Create AntOpsClient with the environment key.
  4. Call a bounded operation such as company.lookup.
import { AntOpsClient } from "@antops/sdk";

const client = new AntOpsClient({ apiKey: process.env.ANTOPS_API_KEY! });
const profile = await client.company.lookup("GB", "00000006");

Verify and expected result

The client defaults to https://api.antops.dev, has a 15-second timeout and surfaces safe typed authentication, rate-limit and request errors.

ANTOPS_BASE_URL is only for a compatible non-production endpoint. Do not expose an API key in a browser bundle.

Common safe checks

Request failed

Check the active key and server-side environment. Do not retry a mutation merely because the transport outcome is unknown.

Security and revocation

Use the SDK server-side. It bounds response size and does not include the key in client errors.

Remove the environment secret from the runtime and revoke the associated API key in AntOps.

Open API documentation