> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the atlanai CLI; `atlanai --map json` prints its command map. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.

# Preview compatibility

> Understand what the public API and CLI references promise during Preview.

The public API and `atlanai` CLI are in Preview. Use the published reference to
build and test an integration, but verify the behavior in your environment
before you rely on it in production.

## What is published

The HTTP reference is composed from reviewed public Agent Gateway snapshots
pinned to one source commit and checksum. The CLI reference is generated from a
reviewed CLI release and its command map. This keeps the site deterministic and
makes the documented path, operation shape, and command flags reviewable.

The generated reference is not a live console. Your API response and installed
CLI binary are authoritative when they are newer than this site.

## What Preview does not promise

Preview does not add a public breaking-change schedule, support window, or
deprecation guarantee. Do not assume that a route, flag, response field, or
integration remains unchanged without checking the current reference and your
environment.

When you update a CLI or API integration, first run a read-only check:

```bash theme={null}
atlanai version
atlanai auth status
atlanai --map json
```

Then re-run the smallest relevant API or CLI workflow in a disposable
workspace. Keep production automation pinned to the release and behavior your
team has validated.

GitHub SkillSync has two version boundaries. A consuming workflow uses the
supported `@v0` Action tag. That Action resolves the current CLI from Atlan's
signed release channel at runtime, so a new CLI can change publish behavior
without a workflow edit. Re-run a disposable SkillSync publish when the
installed CLI version changes.

## Follow the right reference

* Use [API quickstart](/api/tutorials/quickstart) to validate a direct HTTP
  credential and workspace scope.
* Use [CLI command reference](/tools/cli/references/commands) for the installed command
  surface and available flags.
* Use [Errors and retries](/platform/references/errors-and-retries) when a changed
  response leaves a write outcome uncertain.