Technical docs
Alloy Technical Documentation Index
Overview
- `home.md` — Home dashboard cards and activity timeline (route `/home`), including credits metrics.
- `workflows.md` — Workflows library (`/workflows`) for organization-owned workflows that are not attached to a specific AI teammate.
- `cowork.md` — Cowork workspace (`/cowork`) for storage-backed document editing and AI teammate chat.
- `invite-flow.md` — Public invite acceptance flow (`/invite/[code]`), including guest sign-in, acceptance, and redirect behavior.
- `auth-and-session.md` — Login/session bootstrap, Google callback behavior, invite interaction, logout, and cross-tab session sync.
- `private-api.md` — Organization-scoped private API under `/api/private`, including storage, trigger, and Stargate routes.
- `hosted-mcp.md` — Hosted MCP endpoint (`/mcp`) for connecting external AI agents to Alloy as AI teammates.
- `stargate.md` — Gateway pattern for connecting Alloy to internal systems behind VPNs, firewalls, and private networks.
- `deployment.md` — Managed and self-hosted deployment options and data residency (Shared Cloud, Dedicated VPC, BYOC, On-Premises) plus LLM options (Alloy-managed, your own provider keys, self-hosted local models).
- `staff.md` — Support reference for the `Staff` UI area, covering people, invites, and AI teammates.
- `skills.md` — Support reference for the `/skills` library, shared builder, and runs pages.
- `internal-chat.md` — Internal chat behavior for Ally and AI teammate conversations.
- `omni.md` — Support reference for the `/omni` inbox and operator message flow.
- `contacts-and-channels.md` — Contact, contact-channel, and conversation linkage model behind Omni, webchat, API, and internal chat identities.
- `message-reactions.md` — End-to-end reactions behavior (backend constraints, omni visibility, widget UX).
- `logs.md` — Org-wide execution logs (`/logs`) for workflow runs across AI teammates and skills.
- `storage.md` — Combined storage reference: `/storage` UI and org storage endpoints.
- `settings.md` — Settings shell with Organization, Webchat, and API Keys pages.
- `datatable.md` — Shared DataTable system used across staff, variables, workflows, and other table views.
- `mcps.md` — Organization connector management (`/mcps`) plus AI teammate MCP assignment behavior.
- `integrations.md` — OAuth integrations page (`/integrations`) for user-scoped provider connections used by OAuth MCPs.
- `models-and-voices.md` — AI model/voice admin pages, provider/capability flags, and admin-only constraints.
- `prompts.md` — Developer-only system prompt catalog (`/prompts`) and its admin API behavior.
- `variables.md` — Org variables and secrets behavior plus admin-only system settings route linkage.
- `chat-widget.md` — Public webchat widget loader, public endpoints, and runtime behavior.
- `sidebar.md` — Sidebar layout, section behavior, and admin-only tool visibility rules.
- `admin.md` — Developer-only admin workspace (`/admin`) for global token stats, user lookup, organization lookup, relogin, and token balance adjustments.
- `agent-tools.md` — Runtime tool catalog and guardrails for AI teammates and related system flows.
- `ally-ai.md` — Ally, the built-in platform assistant: runtime context, action surface, and onboarding behavior.
- `agent-loop.md` — Agent step loop, prompt/tool execution, streaming, and token handling.
- `workflow-engine.md` — Workflow engine behavior, supported node types, trigger surfaces, and run APIs.
- `jobs-and-schedulers.md` — Recurring scheduler rules, queued jobs, execution lifecycle, and their relationship to workflow runs.
- `alloy-ai-node.md` — Alloy AI node basics and configuration constraints.
- `realtime-voice.md` — Realtime voice session architecture, provider routing, and operator handoff implications.
- `onboarding.md` — Default organization bootstrap, first AI teammate redirect, and Ally onboarding message.
- `operations-runtime.md` — Runtime/ops notes relevant to support (sessions, shutdown, Telegram error signaling, cookies).
- `defaults.md` — Developer-only system defaults (`/defaults`) for prompt/model fallbacks, Ally, and onboarding settings.
- `scout-logs.md` — Developer-only Scout logs page (`/scout-logs`) for app, jobs, network, and live-tail views.
- `troubleshooting.md` — Practical troubleshooting workflow and high-signal checks.
- `work-with-alloy-plugin.md` — Claude Code / Codex plugin that connects an AI agent to Alloy MCP and loads the work-with-alloy skill automatically.
- Folder `Teammate profiles` — canonical templates of AI agents.