Skip to main content
Use these cookbooks to complete a bounded task with Atlan’s public APIs and supported automation tools. Each recipe states its outcome, prerequisites, calls, and verification step, so people and agents can follow it without reconstructing a workflow from reference pages.
These recipes use the HTTP API, which is the lowest-level surface and the one that always works. For several of these tasks the CLI, an SDK, or MCP is the shorter path — pick a surface before you start writing requests.

​
Before you start

Direct HTTP API requests need an Atlan gateway URL and the authentication required by that API. MCP clients complete OAuth with the public MCP endpoint. The CLI resolves its own credential after atlanai auth login, and the tracing SDKs read an API key and workspace from your environment. The authenticated identity determines the workspaces and actions available to the request, whichever surface you use.
  • Read authentication and keep credentials in an approved secret store.
  • Use workspace access deliberately. A successful request can create, change, or expose resources only in workspaces available to the caller.
Start with the API quickstart when you have not yet verified the credential, workspace scope, and response shape in your own environment.

​
Pick a surface

Atlan exposes the same Registry through four surfaces. The API is the most general and the most work; the others are usually shorter for the same task. For a coding agent whose sessions you want captured with no code change at all, neither of these applies — install the Claude Code trace plugin.

​
By task

​
Cookbooks

Skills

Package, publish, find, retrieve, and inspect a reusable skill.

MCP servers and tools

Find a registered server, test it, and inspect its tools.

Agents

Register Agents and record activity from an external runtime.

Ontology

Publish a logical model and retrieve bounded context from an exact release.

Trace imports

Copy external trace evidence through OTLP and verify it in Atlan.

Errors and retries

Recover from documented API failures without duplicating a write.

​
Use the right surface

The site does not send live requests or store credentials. Run examples from an approved development or deployment environment.