Skip to content
AI Building

Build an Atrium app with AI

One minimised file with everything an AI tool needs: how to work, the hard rules, the full app contract and the design system. Upload it to any LLM, then describe your app.

ATRIUM-AI-BUILD.mdMarkdown
  1. Upload the file to ChatGPT, Claude, Cursor or any AI tool (or paste its contents).
  2. Describe the app you want in plain English.
  3. Let the AI ask you for the API key when it needs one.
View the file
Auto

App sample

hello-agent-node

View .md

Class: agent (exception). This sample has no quick view and no app UI.

Almost every Atrium app should start from hello-node (or hello-python / hello-go / hello-dotnet) and ship a quickViewPath. Use this sample only when the product is truly background: webhooks + Public API + optional light Store prefs, and managers never need to open a screen.

Birthday-style automation fits. Payments, reports, applicant review, multi-step setup, and one-off actions do not — use a web-app hello instead.

Default port: 5104 (PORT env override).

Partner builders (and their AIs) were copying a config-only skeleton and shipping products that need UI without one. The four language hellos are the standard (quick view). This fifth sample is the explicit exception, with wording that says so in the README and the manifest.

Terminal window
npm start

Set ATRIUM_SETUP_SECRET before connect (Hosting injects it). Optional ATRIUM_DATA_DIR persists connection secrets and prefs.

  • /health
  • signed /webhooks/atrium/* (setup, disconnect, events)
  • signed native light config at /config/schema and /config

There is no /ui and no /configure. The Store will not offer Open quick view.

For local Store registration, use manifest.example.json — note quickViewPath is omitted on purpose.

Signature verification matches the app developer spec.

Terminal window
npm test