Public API

Use the HTTP API for direct access to Registry artifacts, skills, agents, traces, evaluation data, and integrations. Every request uses the caller’s authenticated identity and permissions.

The public API is in Preview. Confirm behavior in your environment before relying on a workflow in production.

Public API areas

Area	Mount	What it covers
Core	`/registry/v1`	Identity, people, workspaces, artifact discovery, relationships, and trace reads
Skills	`/skill/v1`	Skill bundles, versions, insights, and traces
Agents	`/agent/v1`	Agents, outputs, frameworks, harnesses, environments, sessions, messages, traces, and project Claws
Files	`/file/v1`	Files, version-pinned content, and upload destinations
Knowledge	`/knowledge/v1`	Knowledge bundles
Evals	`/eval/v1`	Datasets, records, experiments, scorers, and scoring runs
Ontologies	`/ontology/v1`	Released context, interchange, query plans, and governed records
Ontology bindings	`/ontology/v1/bindings`	Physical mappings for released logical definitions
MCP	`/mcp/v1`	Server registration, discovery, connection checks, saved tool catalogs, MCP definition authoring — each version’s tool list, drift reports against linked servers, and endpoint tests without a credential — version comparison, and reads of a tool’s MCP App UI resource
Models	`/openai/v1`, `/anthropic/v1`, `/model/v1`	Model Gateway: OpenAI- and Anthropic-compatible inference, the model catalog, and supported providers
Credentials	`/secret/v1`	OAuth setup, connections, and agent on-behalf-of token requests
HTTP API proxy	`/api/v1`	Forward requests to a registered external API’s base URL with its linked credential injected. Check it by calling a read-only route of that API through the proxy
GitHub	`/github/v1`	Connections, installations, repository bindings, and synchronization
Slack	`/slack/v1`	Workspace and personal connections
Repositories	`/repo/v1`	Repository registration and lookup
Apps	`/application/v1`	App drafts and app-definition releases
Store	`/store/v1`	Items, installations, publications, and submissions
Objectives	`/objective/v1`	Objective schedule, arm, and pause operations
Observability	`/otel/v1`	Authenticated OTLP/HTTP logs, metrics, and trace ingestion

Available areas depend on your account’s installed apps and permissions. A public reference entry does not grant access to that operation. Private operations are excluded from this reference.

Model and MCP interfaces

For inference, use Model API compatibility, including the /openai/v1 and /anthropic/v1 dialects. Those request shapes depend on the selected model and provider. MCP clients connect to https://api.atlan.com/mcp over Streamable HTTP. Use Connect client to MCP Gateway and MCP reference for executable tools. The MCP endpoint takes one query parameter, tools. By default, or with tools=search, tools/list returns five tools, mcp__search_tools, mcp__describe_tools, and the runners mcp__call_read_tool, mcp__call_write_tool, and mcp__call_tool, that find, describe, and run every other tool; see Search mode tools. With tools=full, tools/list returns every tool you can reach. Full mode will be deprecated later. The REST tools listing is a saved discovery projection; authenticated MCP tools/list is the current callable catalog. For interactive tool views, see MCP App metadata and resources. UI-capable MCP clients can also receive authorized native App entries alongside the search helpers. The REST App-resource endpoint supplies HTML and policy metadata to an authenticated host; it does not render the view or execute the tool.

Reference and verification

The generated HTTP reference preserves reviewed public paths, operations, request shapes, and response schemas. It is a published contract snapshot, so confirm changes against the API your application calls. See Preview compatibility. The API playground is disabled. This site does not store credentials or send live requests.

Start here

API quickstart

Make three read-only requests before you build a write workflow.

Cookbooks

Complete Skill, MCP, Agent, and coding-harness tasks step by step.

Authentication

Review authentication requirements for direct HTTP API requests.

Compatibility

Understand the Preview contract and deterministic reference process.

Get started

Authenticate requests

Send and inspect traces

Record and replay sessions

Use MCP app resources

References

Endpoints

Public API areas

Model and MCP interfaces

Reference and verification

Start here

API quickstart

Cookbooks

Authentication

Compatibility