> ## 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 SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. 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.
> These docs cover Atlan AI Registry, Atlan's hosted product. The AI registry specification and aireg CLI are maintained separately. /open-source lists publicly reachable signed installers and explains that the source repository and hosted CLI reference currently require GitHub access. Do not claim the repository or its reference docs are publicly accessible. Use these docs for Atlan-specific setup such as the adapter, sign-in and workspaces.

# Call Atlan APIs with aireg

> Use an Atlan registry account to call public APIs from the CLI and save one-time credentials to a private file.

Use `aireg atlan api` when a public API has no dedicated CLI command. It uses
the selected Atlan registry's origin and credentials, so you do not need to
copy a bearer token into a command argument.

## Before you begin

[Set up the Atlan adapter](/tools/brain/how-tos/use-with-atlan) and confirm your
account with `aireg auth list`. Use the [public API reference](/api/references/api-reference)
to choose the method, path, and request body. Your account still needs the
operation's permissions and workspace access.

## Start with a read

```bash theme={null}
aireg atlan api get /registry/v1/auth/whoami --registry atlan
aireg atlan api get /registry/v1/workspaces --registry atlan
```

Check the returned identity and workspaces before making a write. With only
one declared Atlan registry, `--registry` is optional. Name it explicitly in
scripts to keep the destination clear.

The path must start with one `/` and stay on the selected Gateway origin.
For a query string, quote the full path:

```bash theme={null}
aireg atlan api get '/agent/v1/agents?limit=10' --registry atlan
```

## Send JSON

For a write, save the request body as JSON and pass `--input <file>`.
`--input -` reads standard input. GET requests do not accept `--input`.
Review the public operation's required fields before sending the request.

## Keep returned credentials out of terminal output

The command removes recognized credential fields from normal output. When an
operation returns a key or other one-time credential that you need to retain,
use `--output-file <new-path>`. The command creates a private file and refuses
to overwrite an existing file. Add `--output-field <dotted-path>` to save one
field instead of the full response.

| Option | Purpose |
| - | - |
| `--registry <name>` | Select the declared Atlan registry and account. |
| `--input <file\|->` | Read a JSON request body from a file or standard input. |
| `--output-file <path>` | Save the response, including credentials, to a new private file. |
| `--output-field <path>` | With `--output-file`, save only the named dotted field. |

Put credential files outside the repository and move their contents into your
approved secret store. A redacted terminal response cannot recover a one-time
key after the request.

## Next steps

Use the [SDK](/tools/sdk/overview) when you need typed requests, application
error handling, or repeated calls from Python or TypeScript.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.