Skip to main content
The Archyon API exposes the same data model and operations the web application uses: workspaces of components and relationships, processes that animate over the canvas, and the people, teams, and stakeholder roles that own each system. Anything that can be done through the UI can be done programmatically through this API. The API is also the foundation of the hosted MCP server, which lets Claude and other Model Context Protocol clients read and edit Archyon workspaces directly with a single OAuth flow.

​
Base URL

All endpoints are nested under /api. There are no versioned URL prefixes today; breaking changes are announced via a banner in the dashboard and a Sunset header on affected endpoints before the change ships.

​
Data model

A small number of resource families compose the entire surface.

Workspaces

Top-level containers. Each workspace belongs to one Clerk organization and holds components, relationships, processes, stakeholder links, and per-workspace membership.

Components & Relationships

Typed nodes and edges. Components have a position on the canvas; relationships connect them with a directed or undirected type.

Processes

Mermaid sequenceDiagram flows whose participants map to component IDs. Rendered as animated step-throughs over the canvas.

People, Teams, Roles

Organization-scoped human entities, attached to components via stakeholder links with a role (Owner, Support, …).

​
Where to look

Quickstart

A guided five-minute walkthrough from minting your first token to creating a relationship.

Connectors

Add Archyon to Claude as a hosted MCP Connector. No tokens to copy, no local install.

Authentication

Bearer tokens — Clerk session JWTs and Archyon Personal Access Tokens.

Errors

The standard { error, code } envelope and a reference of every documented code value.

Conventions

Identifier formats, organization scoping, timestamps, PATCH semantics, and other invariants.
The API Reference tab in the navigation contains the full endpoint catalogue with request and response schemas, generated directly from the OpenAPI specification.

​
Specification

The API is described by an OpenAPI 3.1 document. The web application, the MCP server, and these docs all consume the same file, and continuous integration rejects any pull request that changes an endpoint without updating the specification in the same commit. To generate a client or import the API into a tool such as Postman or Insomnia, fetch the raw file: