API Reference Beamlet v#0.1.1

Copy Markdown View Source

Modules

Beamlet is an Elixir server that your AI agent builds from the inside.

Serves the files the beamlet's pages load, under /beamlet/assets.

The command line for setting up the owner and managing tokens and policies on your beamlet.

The :beamlet application config.

Reads a config.exs from the data dir when a release boots.

The define tool, which compiles modules into your beamlet and keeps them.

The eval tool, which runs Elixir code on your beamlet.

The patch tool, which edits the source of modules agents defined.

The MCP server agents connect to, at /beamlet/mcp.

How chat clients connect to your beamlet with OAuth.

The beamlet's owner, the one user who signs in to the app.

A policy decides what a token's requests may do on your beamlet.

The policy Beamlet ships, which every token starts from.

The beamlet's own database: the owner, their sessions, the tokens and the routes agents mount.

The router your app forwards to, which serves the beamlet.

The credential one client uses to reach your beamlet.

Creates, updates, lists and deletes tokens from code.

The owner's sign-in to the beamlet's own pages.

A plain error view for your endpoint.

Discover what is on your beamlet, read its docs and source, and remove modules.

File, scoped to your beamlet's files.

HTTP requests with Req's arguments, answered with a Req.Response.

The error for a request Host.HTTP will not send.

Durable key/value storage for small state under string keys.

Run the migrations you define against the agent database, and read their history.

Publish/subscribe on your beamlet's shared message bus.

The agent database: SQLite, shared by every module on your beamlet.

Mount your modules at URLs your beamlet serves.

The use line for a module on your beamlet's web surface.

Mix Tasks

Runs the beamlet command line from Mix, in development.