API Structure

Triform exposes one consistent API shape for all element types.

Flat URLs

/api/{circle}/{slug}

Categories such as actions, data, frontend, and io are metadata used for dispatch, search, UI grouping, and policy. They are not path segments.

Operations

Every element can expose operations:

/api/{circle}/{slug}/ops/{operation}

The operation list and input schemas come from chemistry YAML, then flow through generated code. This keeps the runtime, docs, and agent tools aligned.

Search

The platform has two relevant search surfaces:

POST /api/search
POST /api/search/docs
POST /api/search/platform

Use docs search when the user needs platform help. Use platform search when the user wants to find both elements and documentation from one query.

Authentication

Triform supports bearer tokens and cookie sessions. Browser UI normally uses cookies; programmatic clients and agents typically use bearer tokens.