Install atlanai SDK

SDK 0.6.0 The atlanai SDK lets you manage Atlan Trident artifacts and report agent traces from Python or TypeScript code. Use it when you want to call the Registry from your own code or send traces from an agent you control. For terminal work, use the CLI with Atlan; from a language with no SDK, use the Public API.

Before you begin

Before you start, make sure you have:

Runtime: Python 3.10 or later, or Node 20 or later.
Package manager: pip or a compatible tool for Python, or npm for TypeScript.

Install atlanai SDK

Each language has one package. In Python, tracing is an extra because it pulls in OpenTelemetry. In TypeScript, tracing is a subpath of the same package. Run the command for your language and the parts you need.

Python
TypeScript

For management only:

pip install 'atlanai==0.6.0'

To add tracing, install the tracing extra. It adds the OpenTelemetry packages that tracing needs:

pip install 'atlanai[tracing]==0.6.0'

If pip reports No matching distribution found for atlanai, your Python is older than 3.10. See No matching distribution found for atlanai.If you use the LangChain or LangGraph handler, add the langchain extra as well:

pip install 'atlanai[tracing,langchain]==0.6.0'

npm install @atlanai/sdk@0.6.0

Tracing is the @atlanai/sdk/tracing subpath of the same package. Its OpenTelemetry dependencies install with the package, so there is nothing else to install.

Verify installation

Check version: Confirms the package resolves and prints the installed version. It does not confirm that your credentials work or that the Gateway is reachable. Installing needs no credentials.

Python
TypeScript

import atlanai
import atlanai.tracing as t   # only if you installed the tracing extra

print(atlanai.__version__, t.__version__)

Both numbers match, because management and tracing share one version. If importing atlanai.tracing raises ModuleNotFoundError, or the numbers differ, see ModuleNotFoundError when importing tracing.

import { SDK_VERSION } from "@atlanai/sdk/tracing";

console.log(SDK_VERSION);

This prints the installed version. If the import fails, the package did not resolve; run npm ls @atlanai/sdk to see what is installed.

Troubleshooting

If the install fails, or atlanai.tracing does not import, see Install and setup errors. The commands above install the release described by this reference. When upgrading, check the installed version before using an operation added in a later release.

Next steps

Connect management client: Verify identity and read agents in a workspace.
Trace your first agent run: Initialize tracing and confirm a trace reaches Atlan Trident.

Get started

References

Troubleshoot

Before you begin

Troubleshooting

Next steps

See also