Skip to content
Grundlag
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Start here
Why Grundlag?
Introduction
A day with Grundlag
Installation
Quickstart
Tutorials
Build your first provider
Run an agent
Run a sandbox script
Guides
Providers
Define actions
Expose entities
Publish events
Persist state with a database
Store blobs in a bucket
Structure a provider package
Human-in-the-loop with interrupts
Emit items
Match spoken phrases
Test a provider
Agents
Configure and run
Stream output and events
Handle interrupts
Sandbox
Execute a script
Type-check scripts
Resume an interrupted script
Wrap a sandbox as an agent tool
Hosting
Compose your own host
Register providers and services
Call the HTTP API
The eval endpoint
Client
Generate a typed client
Call actions and search entities
Run agents and sandboxes on the client
Concepts
Architecture
Primitives
Tools and transports
Providers and registries
Services and dependency injection
Validation and schemas
Determinism and resumption
The agent run loop
Interrupts
Reference
HTTP API
API (generated)
@grundlag/core
Classes
ActionAlreadyRegisteredError
ActionInputValidationError
ActionOutputValidationError
ActionRegistry
Bucket
BucketIdConflictError
BucketObjectNotFoundError
BucketRegistry
BucketService
ConflictError
CoreError
DatabaseMigrationError
DatabaseService
EntityRecordNotFoundError
EntityTypeRegistry
EventEmitter
EventFilterValidationError
EventPayloadValidationError
EventRegistry
InvalidBucketKeyError
InvalidRequestError
ItemTypeAlreadyRegisteredError
ItemTypeRegistry
ItemValidationError
NLPActionRegistry
NlpEntityRegistry
NotFoundError
ProviderConfigValidationError
ProviderInstance
ProviderRegistry
ProviderTypeRegistry
Services
Slot
ToolInterrupt
UnknownItemTypeError
Utterance
Type Aliases
Action
ActionContext
AllocatedAction
AllocatedEntityTool
AllocatedTools
BucketCreator
BucketInstanceOptions
BucketListOptions
BucketObject
BucketOptions
BucketPutOptions
BucketStorage
DatabaseCreator
DatabaseOptions
EmittedItem
EntityOperation
EntityToolShape
EntityType
Event
EventCheckContext
ItemType
Logger
NLPAction
NLPActionContext
NLPActionExecute
NLPActionOptions
NlpEntityMatch
Prompt
PromptInterrupt
PromptInterruptResolution
PromptOutput
PromptOutputItem
PromptOutputText
PromptOutputToolCall
PromptUserContent
ProviderContext
ProviderType
SlotGetContext
SlotOptions
SlotRef
SlotValue
SubscribeOptions
Tool
ToolContext
ToolItems
ToolResumption
UtterancePart
Variables
destroy
pagingSchema
promptInterruptResolutionSchema
promptInterruptSchema
promptOutputItemSchema
promptOutputSchema
promptOutputTextSchema
promptOutputToolCallSchema
promptSchema
promptUserContentSchema
Functions
allocateActionNames
allocateToolNames
assertValidBucketKey
createConsoleLogger
createMemoryCreator
createMemoryStorage
defineAction
defineBucket
defineDatabase
defineEntityType
defineEvent
defineItemType
defineNLPAction
defineProviderType
defineTool
entityToolShape
invokeAction
renderItemForAgent
slot
toEntityTool
toFunctionName
toTool
utterance
References
ActionInterrupt
ActionItems
ActionResumption
@grundlag/shared
Classes
ItemTypeAlreadyRegisteredError
ItemTypeRegistry
ToolInputValidationError
ToolInterrupt
ToolOutputValidationError
Type Aliases
ActionEnvelope
EmittedItem
ItemStore
ItemType
Logger
Tool
ToolContext
ToolItems
ToolResumption
Variables
emittedItemSchema
toolResumptionSchema
Functions
actionRequestSchema
actionResponseSchema
createConsoleLogger
createItemStore
defineItemType
defineTool
renderItemForAgent
@grundlag/agent
Classes
Agent
AgentRun
Type Aliases
AgentRunEvents
AgentRunOptions
AgentRunResult
AgentRunState
@grundlag/sandbox
Classes
CallLogMismatchError
Sandbox
SandboxInterrupt
ScriptCompileError
Type Aliases
ActionDescription
CallLogEntry
CreateSandboxToolOptions
SandboxCheckpoint
SandboxConsoleEntry
SandboxEvalResult
SandboxExecOption
SandboxOptions
SandboxResumption
SandboxTool
ScriptDiagnostic
Variables
callLogEntrySchema
sandboxCheckpointSchema
sandboxConsoleEntrySchema
sandboxDataItemType
Functions
checkScript
combineSandboxTypes
createSandboxTool
generateActionTypes
@grundlag/server
Type Aliases
CreateAppOptions
Variables
aiRoutesPlugin
Functions
createServer
@grundlag/client
Classes
ClientRequestError
ToolInterrupt
Type Aliases
ActionCallOptions
ActionClient
BucketClient
BucketListOptions
BucketObject
BucketPutOptions
BucketsClient
Client
ClientManifest
ClientOptions
EntityClient
GenerateOptions
HeaderProvider
ProviderClient
SchemaShape
SchemaSourceOptions
SearchOptions
SearchResult
Functions
createClient
fetchClientManifest
generateClientTypes
@grundlag/nlp
Classes
NlpEngine
NlpIntentNotFoundError
NlpService
Type Aliases
NlpClassifyOptions
NlpEngineOptions
NlpExecuteOptions
NlpIntent
NlpMatch
NlpProviderActions
Select theme
Dark
Light
Auto
EmittedItem
type
EmittedItem
=
z
.
infer
<
typeof
emittedItemSchema>;
Defined in: tool/tool.ts:21