Skip to content
Kuralle
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Overview
Examples
Catalogue
Agentic Commerce
Start
Quickstart
Build an Agent
File-authored Agents
Templates
Core model
Agents
Flows
Flow Execution Model
Dynamic Flows
Tools
Routing & Handoffs
Context & state
Sessions & State
Memory
Knowledge & Retrieval
Skills
Agent Plugins
MCP
Workspace (Filesystem & Shell)
Multimodal Input
Production
Pi Driver
Tool Policy
Durable Execution
Engagement & Messaging
Deployment
Agent Builder in React
Agent Definitions in Your Database
Observability
CLI & Devtools
API Reference
@kuralle-agents/core
@kuralle-agents/core
Classes
AiSdkModelTurnLoop
AutoRetrieveCapability
CapabilityHost
CompositeSkillStore
ContextBudget
DefaultAgentStateController
EvalRunner
ExtractionCapability
FileExtractedValueStore
FilePersistentMemoryStore
FlowCycleError
FlowDefinitionConflictError
FlowDefinitionNameMismatchError
FlowDefinitionNotFoundError
FlowDriftError
FlowNameConflictError
GuardrailCapability
InlineSkillStore
InMemoryConversationStore
InMemoryExtractedValueStore
InMemoryPersistentMemoryStore
InvalidBlockKeyError
InvalidCallerMessagesError
InvalidOwnerError
LiveFlowCatalog
LogConflictError
MemoryFlowDefinitionsStore
MemoryStore
MemoryTraceStore
OtelTraceSink
PassThroughRefinement
PassThroughValidation
PromptBuilder
PromptTemplateBuilder
RecoverableToolError
RoutedPersistentMemoryStore
RunNotFoundError
RunNotTerminalError
Runtime
SessionManager
SessionWorkingMemory
SkillsCapability
StaleWriteError
StepNotFoundError
TextDriver
TieredPersistentMemoryStore
TokenAccumulator
ToolApprovalDeniedError
ToolEnforcer
ToolTimeoutError
TraceRecorder
Interfaces
ActionNode
AgentCapabilityDescriptor
AgentConfig
AgentContext
AgentKnowledgeOverrides
AgentSpan
AgentState
AgentStateController
AgentTrace
AgentWorkspaceResolverContext
AiSdkTelemetryConfig
AnthropicCacheMarker
ApplyPromptCacheInput
ApplyPromptCacheResult
AuditConfig
AuditEntryBase
AuditListOptions
AuditReplayOptions
AuthConfig
AuthoringFlowDefinition
AutoRetrieveCapabilityConfig
Capability
CapabilityPromptSection
ChannelDriver
ChannelPolicy
ChannelPolicyResult
ChoiceOption
CollectNode
CompactionConfig
CompactionSkippedPayload
ConfirmGate
ContextBudgetConfig
ContextCompactedPayload
ContextOverflowRecoveredPayload
ConversationJudge
ConversationOutcomePayload
ConversationOutcomeRecord
ConversationStore
CpOptions
CreateFlowBuilderAgentOptions
CreateFsToolOptions
CreateJudgeOptions
CreateShellToolOptions
CreateVersionOptions
CsatRecord
CustomPayload
DateParserOptions
DecideNode
DefineExtractorConfig
DefineSkillConfig
DeleteRunOptions
DeploymentTraceContext
DirectoryEntry
DonePayload
EnforcementContext
EnforcementResult
EnforcementRule
ErrorPayload
EscalationConfig
EscalationPayload
EscalationRequest
EvalScenario
EvalTurn
ExtractedValue
ExtractedValueStore
ExtractedValueStoreConformanceCase
ExtractionCapabilityConfig
ExtractionConfig
ExtractionPayload
ExtractionRunResult
ExtractionToolResponseEnvelope
Extractor
ExtractorOnExtractedContext
ExtractorRuntimeContext
FactsExtractorOptions
FileEntry
FileInit
FileSystem
FileSystemDirent
FinalResult
Flow
FlowBuilderCatalogEntry
FlowBuilderHost
FlowBuilderRuntime
FlowCatalogDelta
FlowCatalogEntry
FlowDefinition
FlowDefinitionListFilter
FlowDefinitionsStore
FlowDefinitionVersion
FlowEndPayload
FlowEnterPayload
FlowGateJudgeProvider
FlowGateVerdict
FlowPromptContext
FlowReconfigureTransition
FlowRegistryIndex
FlowRehydrationDeps
FlowStateBoundary
FlowTransitionPayload
FlowValidationIssue
FlowValidationRepairAction
FlowVerificationRecord
FrozenToolOperation
FsError
FsSkillStoreOptions
FsStat
GeminiFunctionDeclaration
GlossaryTerm
GrepHit
GroundingValidatorOptions
Guardrails
HandoffInputData
HandoffInputResult
HandoffPayload
HandoffRecord
HandoffResult
HarnessConfig
HitlInterrupt
Hooks
HttpCallbackConfig
HttpParam
HttpToolConfig
HttpToolResult
Injection
InputProcessor
InputProcessorResult
InteractivePayload
InterruptDecisionRecord
InterruptedPayload
InterruptRequest
JudgeDimension
JudgeVerdict
KnowledgeCacheHitPayload
KnowledgeCacheMissPayload
KnowledgeEmbedderAdapter
KnowledgeProviderConfig
KnowledgeQualityCheckPayload
KnowledgeReformulationPayload
KnowledgeRetrievalResult
KnowledgeRetrieverAdapter
KnowledgeSearchPayload
LangfuseSinkOptions
LazyFileEntry
Limits
MarkOutcomeToolResult
MemoryTraceStoreOptions
MkdirOptions
ModelCallEndPayload
ModelCallStartPayload
ModelTurnLoop
ModelTurnLoopInput
ModelTurnLoopState
ModerationGuardOptions
NlPredicateProvenance
NlPredicateProvider
NodeEnterPayload
NodeExitPayload
NodeGrounding
OpenAIResponsesCompactOptions
OtelTraceSinkOptions
OutputProcessor
OutputProcessorResult
OverflowRecoveryResult
PackagedSkill
PackagedSkillFile
ParsedDateResult
ParsedSkill
PausedPayload
PersistedFlowFrame
PersistedFlowPark
PersistedLiveFlowCatalog
PersistedRun
PersistentMemoryBlock
PersistentMemoryConfig
PersistentMemoryStore
PersonaConfig
PersonaExperimentConfig
PersonaExperimentMetadata
PersonaExperimentResolution
PiiGuardOptions
PiiMatch
PiiScanResult
PipelineValidationBlockPayload
Policy
PolicyRequest
PredicateContext
ProcessorContext
PromptInjectionGuardOptions
PromptSection
PromptTemplate
ReadFileOptions
RecoverOrphanedRunsOptions
RecoverOrphanedRunsReport
RefineInput
RefinementCapability
ReplyNode
ResolvedAgentWorkspace
ResolvedExtractor
ResolvedNode
ResolvedSelection
RetrievalCacheAdapter
RetrieveProvider
RmOptions
Route
RoutedPersistentMemoryStoreConfig
RunContext
RunExtractorsOptions
RunFilter
RunFlowRef
RunHandle
RunOptions
RunRef
RunSimulationSuiteOptions
RunState
RunStore
RuntimeLike
SafetyBlockedPayload
ScenarioScore
ScheduledJob
Scheduler
Session
SessionMetadata
SessionStore
SessionTrace
Shell
ShellExecOptions
ShellResult
SignalActor
SignalDelivery
SimulatableRuntime
SimulateConversationOptions
SimulatedTranscriptTurn
SimulatedUserPersona
SimulationResult
SimulationScenario
SimulationSuiteResult
SkillActivation
SkillDiagnostic
SkillFileHandle
SkillHandle
SkillLike
SkillMeta
SkillResolverContext
SkillStoreLike
SkillWireAgent
SourceRef
StepFinalizePatch
StepRecord
StreamCallbackConfig
StreamCallbackPayload
StreamCallbackSink
StreamPartBase
SweepDeadlinesOptions
SweepRuntime
SymlinkEntry
TextCancelPayload
TextDeltaPayload
TextDriverConfig
TextEndPayload
TextStartPayload
Tool
ToolBatchStartPayload
ToolCallPayload
ToolCallRecord
ToolDeclaration
ToolDefinition
ToolDeniedResult
ToolExecutionContext
ToolGuideline
ToolPolicy
ToolResultPayload
ToolResultRecord
ToolWithFiller
TraceListWindow
TraceRecorderOptions
TraceSink
TraceStore
TracingConfig
TrackedGoal
TurnEndPayload
TurnHandle
TurnIncompletePayload
TurnResult
TurnScore
TurnUsage
UnresumableRun
ValidateInput
ValidationCapability
VoiceRulesConfig
WakeDelivery
WakeJobPayload
WakeOptions
WakePayload
WakeRunnable
WiredAgentSkills
WorkingMemory
WorkingMemoryBlockSpec
WorkingMemoryConfig
WriteFileOptions
Type Aliases
ActionContext
AgentWorkspaceConfig
AgentWorkspaceDefinition
AgentWorkspaceResolver
AiSdkTool
AnthropicCacheTtl
AnyTool
AuditEntryType
AuditEscalationReason
BufferEncoding
CapabilityAction
ChannelId
ChannelPolicyChange
CollectResolverSpec
CompactionResult
ConfirmVerdict
ConversationAuditEntry
ConversationAuditLog
ConversationOutcome
ConversationOutcomeMarkedBy
EscalationHandler
EscalationOutcome
EscalationReason
ExtractionTrigger
FactsValue
FileContent
FileSystemEntryType
FlowDefinitionVersionStatus
FlowDriftRecovery
FlowGateSpec
FlowNode
FlowNodeDefinition
FlowState
FlowValidationIssueCode
FsEntry
GoalStatus
HandoffInputFilter
HttpMethod
InitialFiles
InjectableTimer
InjectionLevel
InjectionPriority
Instructions
JsonSchema
KnowledgeChunk
KuralleDataParts
KuralleMetadata
KuralleUIMessage
LazyFileProvider
MappingConfig
MappingSource
McpToolCatalogEntry
MemoryBlockScope
MemoryRouteFn
NlPredicate
NodeToolScope
ParamType
PathOrLiteral
PersonaExperimentCohort
PersonaLanguagePolicy
PersonaRegister
PersonaVoice
PiiDetector
PolicyDecision
Predicate
ProcessorAction
PromptCachePath
RefineDecision
RouteCondition
RunKind
RunStatus
SaveFlowResult
SessionDurableRuns
SimulationEnd
SkillEntry
SkillResolver
SkillSource
SlotSource
SpanKind
StreamChannel
StreamPart
ToolContext
ToolExecutionOptions
ToolSet
Transition
TransitionRef
UnresumableReason
UserInputContent
UserSignal
ValidateDecision
Variables
ALLOW
authoringPredicateSchema
BuiltinPersonas
commonDateExpressions
dateParser
DEADLINE_EXPIRED_REASON
DEFAULT_AUTO_LOAD_BLOCKS
DEFAULT_BLOCK_CHAR_LIMIT
DEFAULT_CHANNEL_POLICIES
DEFAULT_COMPACTION_KEEP_RECENT
DEFAULT_COMPACTION_TRIGGER_TOKENS
DEFAULT_CONTEXT_BUDGET
DEFAULT_EXTRACTION_TRIGGER
DEFAULT_HANDOFF_INSTRUCTION
DEFAULT_JUDGE_DIMENSIONS
DEFAULT_RUN_LEASE_TTL_MS
DEFAULT_SWEEP_INTERVAL_MS
DURABLE_RUNS_KEY
encodeSegment
extractedValueStoreConformanceCases
FACTS_EXTRACTOR_SLUG
FLOW_BUILDER_AUTHORING_PLAYBOOK
FLOW_BUILDER_TOOL_NAMES
FLOW_CATALOG_NOTE_TAG
FLOW_DEFINITION_VERSION_STATUSES
FLOW_GATE_JUDGE_SYSTEM
flowDefinitionSchema
flowGateJudgeResultSchema
flowGateSpecSchema
FRAMEWORK_SKILL_TOOLS
handoffFilters
needsApprovalPolicy
NL_PREDICATE_COMPILER_VERSION
nlPredicateSchema
OUTCOMES_MARK_TOOL_NAME
PART_CHANNEL
predicateSchema
SALES_AGENT_TEMPLATE
SUPPORT_AGENT_TEMPLATE
SWEEP_JOB_KIND
SWEEPER_ACTOR_ID
TRIAGE_AGENT_TEMPLATE
VOICE_CONTEXT_BUDGET
WAKE_JOB_KIND
Functions
action
aggregateScores
appendVolatileSystemBlocks
applyAnthropicCacheControl
applyChannelPolicy
applyConversationCacheControl
applyLastToolCacheBreakpoint
applyPromptCache
applySystemCacheBreakpoint
asFlowGateJudgeProvider
assertValidBlockKey
assertValidFlowDefinition
assertValidOwner
assertValidSlug
brandPackagedSkill
buildEscalationRequest
buildMarkOutcomeTool
buildMemoryBlockTool
buildOpenAIResponsesProviderOptions
buildSearchMemoryTool
buildSkillBriefing
buildToolSet
canonicalJson
classifySkillFileKind
clearRunLease
cloneFlowDefinitionVersion
collect
collectRegisteredNames
compactMessages
compileAuthoringPredicates
compileNlPredicate
composeFilters
composeFlowBuilderInstructions
composePersonaPrompt
composePolicies
computeMessageHistoryBudget
confirmGate
consumeAllPendingUserInput
consumePendingUserInput
createAgentGetSkill
createDateParser
createFlowBuilderAgent
createFlowBuilderTools
createFlowTransition
createFlowTransitionWithNode
createFlowUpdate
createFsTool
createGroundingValidator
createHandoffTool
createHttpTool
createInProcessScheduler
createJudge
createModerationGuard
createModerationOutputGuard
createNoSkillsGetSkill
createPiiInputGuard
createPiiOutputGuard
createPromptInjectionGuard
createPromptTemplate
createRuntime
createScheduleFollowupTool
createShellTool
createSkillHandle
createSupportAgentTemplate
createSweepJobRunner
createTool
createToolEnforcer
createToolWithFiller
createWakeJobRunner
currentFlowState
deadlineExpiryDelivery
decide
decodeFileSegment
defineAgent
defineExtractor
defineFlow
defineSkill
defineTool
derivePredicateLabel
detectPromptCachePath
detectToolCatalogDrift
detectTurnHadToolCalls
digestForLiveFlow
encodeFileSegment
encodeRedisSegment
ensureSessionMetadata
estimateMessagesTokens
estimateTokenCount
evaluateFlowGates
evaluatePredicate
factsExtractor
filterAuditEntries
findFlowByName
findUnresumableRuns
fingerprintToolCatalog
flowDigest
formatDateForSpeech
formatMemoryWithBudget
formatTimeForSpeech
formatWorkingMemorySection
fsErrorCode
fsSkillStore
gateFailureIsBlocking
getAllTemplates
getAnthropicCacheMarker
getDefaultChannelPolicy
getTemplate
harnessToUIMessageStream
hasMediaParts
hasPendingUserInput
isAnthropicLanguageModel
isArchivedFlowName
isContextOverflowError
isFinalResult
isFlowGateJudgeProvider
isFlowTransition
isFlowUpdate
isHandoffResult
isNlPredicate
isOpenAIResponsesModel
isPackagedSkill
isPackagedSkillArray
isRunLeaseStale
isSkillStore
isSweepJob
isTerminalRunStatus
isTraceStore
isValidBlockKey
isValidOwner
isWakeJob
keepRecentMessages
knownVariablesFromDefinition
langfuseSink
listTemplates
loadWorkingMemoryBlocks
matchesFlowDefinitionListFilter
mergeGatewayAutoCaching
mergeUserInputContents
otelSink
packagedSkillStore
parseConfirmation
parseDate
parseDateRange
parseSkillFrontmatter
peekPendingUserInput
permittedToolNames
preloadMemoryContext
prepareSkillStore
readOnlyPolicy
recordSkillActivation
recoverFromContextOverflow
recoverOrphanedRuns
redactPii
registerAiSdkOpenTelemetry
registerTemplate
rehydrateFlow
removeKeys
removeToolHistory
renderScopeTemplate
reply
resetSkillActivations
resolveAgentWorkspace
resolveAgentWorkspaceForSession
resolveChannelPolicy
resolveExtractedValueStore
resolveExtractionConfig
resolveExtractor
resolveMapping
resolvePersonaExperiment
resolveWorkingMemoryStore
reviveFlowDefinitionVersion
reviveSession
runExtractors
runKind
runMatchesFilter
runOnce
runSimulationSuite
scanMemoryWrite
scoreTurn
setPendingUserInput
shouldExtract
simulateConversation
skillRestrictionPolicy
slugifyExtractorName
stampNewFlowDefinitionVersion
startRunSweeper
sweepDeadlines
sweepJob
takeRunLease
toAISDKTools
toConversationOutcomeStreamPart
toGeminiDeclarations
toolDeniedResult
toolErrorResult
toolToAiSdk
toOtlpPayload
toRunRef
toStorableFlow
transcribeAudioParts
truncateToTokenBudget
userInputToText
validateExtractorList
validateFlowDefinition
validateSkillAllowedTools
wakeJob
wireAgentSkills
wireSearchMemory
wireWorkingMemory
withOwnerValidation
wrapAiSdkTool
@kuralle-agents/hono-server
@kuralle-agents/hono-server
Interfaces
ChatCompletionsRequest
CreateOpenAICompatRouterOptions
CreateStoredFlowsRouterOptions
DeploymentControlPlaneAuthorization
DeploymentControlPlaneRouterOptions
DeploymentPrincipal
DeploymentRouterOptions
OpenAICompatRuntime
StoredFlowsRuntime
StoredFlowVersionBody
ThreadExecutionCoordinator
ThreadExecutionLease
Type Aliases
ChatRequest
ChatResponse
FlowRequest
FlowResponse
KuralleChatRouterOptions
KuralleRouterOptions
KuralleSseChatRouterOptions
KuralleWebSocket
ResumeRequest
StreamEventFilter
StreamPart
UpgradeWebSocket
WebSocketEvent
WebSocketHandler
WebSocketTransportFrame
Variables
STORED_FLOWS_READ
STORED_FLOWS_WRITE
Functions
createDeploymentControlPlaneRouter
createDeploymentRouter
createKuralleChatRouter
createKuralleRouter
createKuralleSseChatRouter
createOpenAICompatRouter
createStoredFlowsRouter
decideStoredFlowsAccess
sanitizeForClient
serializeStoredFlowVersion
shouldEmit
@kuralle-agents/tools
@kuralle-agents/tools
Interfaces
FilterableFieldDescriptor
VectorRetrievalToolOptions
VectorRetrievalToolOutput
Type Aliases
CagAnswerInput
CagAnswerOutput
CagAnswerTool
CagAnswerToolOptions
CagRetrieveInput
CagRetrieveOutput
CagRetrieveTool
CagToolOptions
ChunkDef
VectorRetrievalToolInput
Functions
createCagAnswerTool
createCagTool
createVectorRetrievalTool
@kuralle-agents/rag
@kuralle-agents/rag
Classes
AiSdkEmbedder
BM25Index
CohereReranker
Fts5KeywordIndex
FusionRetriever
HybridRetriever
InMemoryIngestManifest
InMemoryVectorStore
KnowledgeCompiler
LLMReranker
MultiHopRetriever
PredictivePreFetcher
RagPipeline
RetrievalCache
RetrievalQualityChecker
SqlIngestManifest
TurnCache
UnsupportedFilterOperatorError
VectorRetriever
Interfaces
AiSdkEmbedderOptions
BM25Document
BM25IndexOptions
BM25SearchResult
Chunk
Chunker
CohereRerankerOptions
CompilationResult
CreateIndexParams
Document
DocumentLoader
Embedder
Fts5KeywordIndexOptions
FusionRetrieverOptions
HybridRetrieverOptions
HybridRetrieverSource
IndexStats
IngestManifest
IngestManifestData
IngestManifestDocEntry
KeywordIndex
KnowledgeCompilerConfig
KnowledgeRetriever
KnowledgeSource
LLMRerankerOptions
MultiHopRetrieverOptions
PredictivePreFetcherConfig
QualityCheckResult
RagPipelineOptions
Reranker
RerankerOptions
RetrievalCacheConfig
RetrievalOptions
RetrievalQualityCheckerOptions
RetrievalResult
Retriever
RuntimeInfo
SqlIngestManifestOptions
TokenChunkerConfig
VectorEntry
VectorQueryParams
VectorQueryResult
VectorRetrieverOptions
VectorStoreCore
VectorStoreIndexAdmin
Type Aliases
ChunkOptions
KnowledgeChunk
LLMRetrieverOptions
QueryDecomposer
QueryReformulator
RetrievalHit
RuntimeEnvironment
SqlExecutor
SqlWhereResult
TokenChunkOptions
TokenCounter
TopicPredictor
VectorFilter
VectorFilterCondition
Functions
assertSqlIdentifier
createLLMRetriever
createMarkdownChunker
createRecursiveChunker
createStaticKnowledgeSource
createTokenChunker
detectRuntime
execSql
hasIndexAdmin
matchFilter
sha256Hex
toCloudflareFilter
tokenizeKeywords
toLanceDbWhere
toRedisFilter
toSqlWhere
toUpstashFilterString
@kuralle-agents/fs
@kuralle-agents/fs
Classes
CompositeFileSystem
InMemoryFs
ReadOnlyFileSystem
SqlFileSystem
Interfaces
BlobStore
CompositeFileSystemConfig
CpOptions
D1DatabaseLike
DirectoryEntry
FileEntry
FileInit
FileSystem
FileSystemDirent
FsData
FsStat
LazyFileEntry
LibsqlHttpOptions
MkdirOptions
OkfConcept
R2Bucketish
ReadFileOptions
RmOptions
SqlBackend
SqlFileSystemFactoryOptions
SqlFileSystemOptions
SqlStorageLike
SymlinkEntry
WriteFileOptions
Type Aliases
BufferEncoding
FileContent
FileSystemEntryType
FsEntry
InitialFiles
LazyFileProvider
SqlParam
SqlSource
Variables
DEFAULT_DIR_MODE
DEFAULT_FILE_MODE
MAX_SYMLINK_DEPTH
SYMLINK_MODE
Functions
containsPath
containsResolvedPath
createFsTool
createGlobMatcher
dirname
fromBuffer
getEncoding
joinPath
libsqlHttpBackend
listOkfConcepts
normalizePath
okfBundleToFs
parseOkfConcept
r2BlobStore
readOnlyFileSystem
resolvePath
resolveSymlinkTarget
sortPaths
sqlFileSystem
toBuffer
toSqlBackend
validatePath
@kuralle-agents/pi-driver
@kuralle-agents/pi-driver
Classes
PiDriver
PiModelTurnLoop
PiStructuredRunner
Interfaces
PiDriverConfig
PiModelResolutionContext
Type Aliases
PiModelResolver
@kuralle-agents/cf-agent
@kuralle-agents/cf-agent
Classes
AgentScheduleCoalesceScheduler
BridgeSessionStore
KuralleAgent
KuralleThreadAgent
OrchestrationStore
QueuedTurnRunner
RuntimeTurnRunner
SqlConsentStore
SqlExtractedValueStore
SqlFlowDefinitionsStore
SqlInboundLedger
SqlOwnershipStore
SqlPersistentMemoryStore
SqlRunStore
SqlThreadPinStore
SqlTraceStore
SqlWindowStore
Interfaces
DurableObjectArtifactWorkspaceOptions
DurableObjectInboundRuntimeOptions
DurableSqlStorage
FileSystemArtifactWorkspaceOptions
HarnessConfig
OrchestrationState
ResolvedRuntimeDefinition
ScheduleHost
Session
Type Aliases
DurableSqlValue
SqlExecutor
StreamPart
Functions
createDurableObjectInboundRuntime
createSqlExecutor
durableObjectArtifactWorkspaceProvider
eventSeqFromSql
fileSystemArtifactWorkspaceProvider
lastUserInputFromMessages
References
CfChatAgent
GitHub
Select theme
Dark
Light
Auto
FsData
Indexable
Section titled “Indexable”
[
path
:
string
]:
FsEntry