Install the SDK

One package per language covers both halves of the SDK:

Management — read and write Registry artifacts: agents, skills, files, sessions, workspaces. Generated from the gateway’s contracts.
Tracing — report what your agent did: spans, cost, scores, Visitor identity. Hand-authored, and installed only if you ask for it.

	Python	TypeScript
Package	`atlanai` (PyPI)	`@atlanai/sdk` (npm)
Version	0.1.1	0.1.1
Management import	`from atlanai import AtlanClient`	`import { AtlanClient } from "@atlanai/sdk"`
Tracing import	`import atlanai.tracing`	`import * as atlan from "@atlanai/tools/sdk/how-tos/tracing"`
Runtimes	Python 3.10–3.13	Node 20+

Management only

Tracing is not installed, so no OpenTelemetry packages are pulled in. If all you need is to create and read artifacts, stop here.

pip install atlanai

npm install @atlanai/sdk

Verify:

from atlanai import AtlanClient

client = AtlanClient("https://api.atlan.com", bearer_token="...")
print(client.auth.whoami())

import { AtlanClient } from "@atlanai/sdk";

const client = new AtlanClient({
  gatewayOrigin: "https://api.atlan.com",
  bearerToken: "...",
});

With the tracing submodule

Tracing needs OpenTelemetry, which is optional in both languages so a management-only install stays dependency-free. Ask for it explicitly.

Python — an extra

pip install 'atlanai[tracing]'

Then import the submodule:

import atlanai.tracing as atlan

client = atlan.init(service_name="support-rover")

Importing atlanai.tracing without the extra raises a ModuleNotFoundError telling you to install it — the module is present, its OpenTelemetry dependencies are not. For the LangChain/LangGraph handler, add langchain-core to your application:

pip install langchain-core

TypeScript — a subpath plus peers

The tracing code ships inside the same package at the ./tracing subpath, but its OpenTelemetry dependencies are optional peers, so install them alongside:

npm install @atlanai/sdk

The tracing subpath’s OpenTelemetry dependencies come with it — there is nothing further to install. Then import the subpath:

import * as atlan from "@atlanai/tools/sdk/how-tos/tracing";

const client = atlan.init({ serviceName: "support-rover" });

Importing @atlanai/tools/sdk/how-tos/tracing without those peers fails with a bare MODULE_NOT_FOUND, which does not say which packages are missing. If you see it, the peer list above is the fix.

Both halves in one process

They are independent by design: separate credentials, separate lifecycles. Tracing does not reuse the management bearer token, so a process doing both configures both.

from atlanai import AtlanClient
import atlanai.tracing as atlan

# Management: explicit gateway origin and bearer.
registry = AtlanClient(
    "https://api.atlan.com",
    bearer_token="...",
    workspace="workspace_01example",
)

# Tracing: its own API key and workspace, from the environment.
tracer = atlan.init(service_name="support-rover")

import { AtlanClient } from "@atlanai/sdk";
import * as atlan from "@atlanai/tools/sdk/how-tos/tracing";

const registry = new AtlanClient({
  gatewayOrigin: "https://api.atlan.com",
  bearerToken: "...",
  workspace: "workspace_01example",
});

const tracer = atlan.init({ serviceName: "support-rover" });

Verify the install

Printing a version confirms the package resolves. It does not confirm that export works — that needs credentials and a reachable Gateway.

import atlanai, atlanai.tracing as t
print(atlanai.__version__, t.__version__)   # 0.1.1 0.1.1

import { SDK_VERSION } from "@atlanai/tools/sdk/how-tos/tracing";
console.log(SDK_VERSION);   // 0.1.1

Management and tracing share one lockstep version, so those two numbers always agree. If they do not, the install is mixed.

API reference

Management only

With the tracing submodule

Python — an extra

TypeScript — a subpath plus peers

Both halves in one process

Verify the install

Next steps

Operations reference

Quickstart

Agents cookbook

Skills cookbook

​Management only

​With the tracing submodule

​Python — an extra

​TypeScript — a subpath plus peers

​Both halves in one process

​Verify the install

​Next steps

Operations reference

Quickstart

Agents cookbook

Skills cookbook

Management only

With the tracing submodule

Python — an extra

TypeScript — a subpath plus peers

Both halves in one process

Verify the install

Next steps