> ## 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.

# Public API

> Browse the current public Registry, Skill, Agent, File, MCP, and OTLP HTTP APIs.

Use the API when your application needs direct access to Registry resources,
Skills, Agents and outputs, Files, MCP catalogs, or OTLP ingestion. Core is the
Registry-backed surface: it resolves the caller's account and workspace scope
and identifies the extension that owns an artifact where that applies. Direct
HTTP API requests apply the caller's account and workspace permissions.

<Note>
  **Preview.** This reference describes the currently published public
  contract. Verify behavior in your environment before relying on it in
  production.
</Note>

## MCP connection endpoint

MCP clients use OAuth with the Streamable HTTP endpoint
[`https://agentgateway.atlan.engineering/mcp`](https://agentgateway.atlan.engineering/mcp).
Use the MCP cookbook for client setup and this reference for server and tool
catalog operations.

The reference is rendered from public OpenAPI artifacts pinned to one reviewed
Agent Gateway commit. It keeps the public paths, operations, request shapes,
and response schemas while presenting the reference with product-facing
labels.

| Section       | Backend mount  | What it covers                                                                                                                          |
| ------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Core          | `/registry/v1` | Registry identity, workspaces, projects, repositories, directory resources, and extension ownership or installation state where exposed |
| Skill         | `/skill/v1`    | Skill bundles, versions, insights, and traces                                                                                           |
| Agent         | `/agent/v1`    | Agents, profile images, outputs, frameworks, coding harnesses, providers, environments, sessions, messages, and traces                  |
| Files         | `/file/v1`     | File lookup, version-pinned content, and upload destinations                                                                            |
| MCP           | `/mcp/v1`      | Registered server and tool catalogs, discovery, and connection tests                                                                    |
| Observability | `/otel/v1`     | Authenticated OTLP/HTTP log, metric, and trace ingestion                                                                                |

The raw snapshots and their checksums are committed in this repository. Refresh
and compose them from a reviewed Gateway commit with:

```bash theme={null}
pnpm docs:sync:public-openapi -- --source-dir <openapi-directory> --source-commit <full-sha>
pnpm docs:compose:public-openapi
```

The API playground is disabled, so this site cannot send requests or store a
token.

## Start here

<CardGroup cols={2}>
  <Card title="API quickstart" icon="play" href="/developers/quickstart">
    Make three read-only requests before you build a write workflow.
  </Card>

  <Card title="Cookbooks" icon="book-open" href="/developers/build-with-atlan">
    Complete Skill, MCP, Agent, and coding-harness tasks step by step.
  </Card>

  <Card title="Authentication" icon="key" href="/developers/authentication">
    Review authentication requirements for direct HTTP API requests.
  </Card>

  <Card title="Compatibility" icon="code-branch" href="/developers/compatibility">
    Understand the Preview contract and deterministic reference process.
  </Card>
</CardGroup>
