Skip to content
Shiitake

API reference

Choose the public entry point for a host, Session client or extension.

Use the root entry for an Agent host, /client for an authorized transport, /extensions for durable contributions and /testing for local fixtures. Generated module pages below retain the complete signatures and types. AcceptedSchema from /client validates a command acceptance received as an RPC value; parseAccepted decodes its serialized JSON form.

Entry When to use it Start with
Root Own durable Sessions and host resources Shiitake, ShiitakeOptions, ShiitakeError, SqliteOwner, RuntimeHost
Client Submit commands and observe an admitted Session createShiitakeClient, AcceptedSchema and the returned Session client
Extensions Define extension state, commands, tools and projections defineExtension, defineCollection, ExtensionId, ExtensionCommandError, ExtensionStop
Testing Run a credential-free canonical host memoryHost, callTool, echoSystemPrompt, fauxModelSource, MemoryHostOptions
HTTP Bind authorized Session routes to an existing host createShiitakeHttpRoutes, ShiitakeSessionResolver, ShiitakeHttpEnv
Client entries Turn a shared projection into bounded UI contributions defineClientEntry, clientContributionSchemaV1
Agent control Give admitted tools a directory of existing Agents createAgentControlSource, waitForAgentSettlement, AgentControlDirectory

The testing host is explicitly driven and uses trusted callbacks. It is not a production isolation boundary. Start with Your first Session, then Your first extension.