NylorunDocsBeta
Get started

Concepts

The words the rest of the docs use for one Nylorun installation.

Clients — Studio, the Agents SDK, HTTP, the CLI, and the Admin SDK — call the Runtime API. The Runtime runs sessions, stores state, keeps artifacts, runs Agents, and records durable execution and streams. Outbound calls to a model provider, MCP, HTTP tools, and the web go through the Gateway.

Words

TermMeaning
TenantOne Nylorun installation: a Runtime with its own database, Studio, and data. Nothing is shared between Tenants. A project gets its own local Tenant; several run side by side on one machine. Requests never name a Tenant — the Runtime's URL is the Tenant's.
RuntimeThe service that runs sessions, calls the model, runs Agents, and stores history and files. Ships as ghcr.io/nylorun/runtime.
agentWhat you author: instructions, tools, skills, MCP servers, plugins, and an output schema, or a flow. Written as an agent manifest's Markdown and JSON files, or built with the Agent() builder from @nylorun/agents. It becomes the harness section of the saved manifest; the Runtime runs it from there and never calls your code during a session. See Agent manifests and Agent builder.
Flow agentAn agent whose body is a flow: its stages decide what runs next. Saved like any agent.
agent manifestA named, versioned document the Runtime stores: a harness section (the agent, and the harness that runs it) and a runtime section (kind, image, network, setup, files, limits, secret slots, and triggers). Saved with client.agentManifests.save() or npx nylorun apply. Its name keys its versions and the Tenant's model budgets. See Saving manifests.
AgentThe live instance of one version of an agent manifest, under an id your app chooses (users/alice/triage): one sandbox (kind virtual, pod, or none), one set of secrets for its shell, MCP servers, and HTTP tools, a disk, memory, triggers, and the sessions that run on it. It tracks its manifest or pins a version, and moves to a new version in place; a fork changes its kind, harness, or storage. See Agents.
HTTP toolA tool the Runtime runs as one HTTP request to your service, through the gateway.
SessionOne durable conversation or flow run on one Agent, owned by ownerUserId.
TurnOne input and everything the agent does until it completes, pauses, fails, or is cancelled.
HarnessThe process that runs a session's turns: nylorun by default, or your own, named by an agent manifest's harness.id. It writes the model's instructions and defines its tools. See Harness.
Tool policyThe Tenant's rules that allow, hold for a person, or deny MCP and HTTP tool calls, for every agent and harness. See Tool policy.
ArtifactA file the Runtime stores: uploads, versions, and short-lived download links.
StudioThe operator dashboard for one Tenant, served on loopback.
Project link.nylorun/link.json and credentials.json, written by nylorun start.
Runtime APIAgent manifests and the folder each version was saved from, Agents (with their forks, secrets, triggers, and memories), sessions (with AG-UI and A2A), definition files, artifacts, and webhooks: /v1/*. Takes application keys. @nylorun/agents speaks it.
Management APIThe Tenant's models, tool policy, credential coverage, signing keys, settings, and application keys: /v1/tenant/*. Takes management keys. @nylorun/admin speaks it.
ScopeWhat a signed-in person may do when your app calls client.as(), for example sessions:own.

Open source

The Runtime, Studio, SDKs, and CLIs are open source. You can build, run, and self-host everything on the Guides tab without a Nylorun account. The Runtime verifies and enforces; it never signs people in or manages users. Your app or your identity provider does that, and the Runtime trusts the tokens it issues.

Next step

On this page