Skip to content
Kuralle
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Overview
Quickstart
Build an Agent
Templates
Guides
Agents
Flows
Flow Execution Model
Tools
Multimodal Input
Durable Execution
Routing & Handoffs
Sessions & State
Memory
Knowledge & Retrieval
Skills
Workspace (Filesystem & Shell)
Voice Agents
Engagement & Messaging
Deployment
API Reference
@kuralle-agents/core
@kuralle-agents/core
Classes
AutoRetrieveCapability
CapabilityHost
ContextBudget
DefaultAgentStateController
DefaultConversationEventLog
DefaultConversationState
DefaultToolExecutor
EvalRunner
ExtractionCapability
FilePersistentMemoryStore
GuardrailCapability
HookRunner
InlineSkillStore
InMemoryConversationStore
InMemoryMemoryService
InMemoryMetrics
InMemoryPersistentMemoryStore
MemoryStore
PassThroughRefinement
PassThroughValidation
PromptBuilder
PromptTemplateBuilder
RoutedPersistentMemoryStore
Runtime
SessionManager
SessionWorkingMemory
SkillsCapability
TieredPersistentMemoryStore
TokenAccumulator
ToolApprovalDeniedError
ToolEnforcer
ToolTimeoutError
Interfaces
AbortOptions
ActionNode
AgentCapabilityDescriptor
AgentConfig
AgentContext
AgentKnowledgeOverrides
AgentRoute
AgentState
AgentStateController
AuditConfig
AuditEntryBase
AuditListOptions
AuditReplayOptions
AuthConfig
AutoRetrieveCapabilityConfig
BeforeModelCallData
BeforeModelCallResult
Capability
CapabilityPromptSection
ChannelDriver
ChannelPolicy
ChannelPolicyResult
ChoiceOption
CollectNode
CompactionConfig
ConfirmGate
ContextBudgetConfig
ConversationEventLog
ConversationJudge
ConversationOutcomeRecord
ConversationState
ConversationStore
CpOptions
CreateFsToolOptions
CreateJudgeOptions
CreateShellToolOptions
CsatRecord
DateParserOptions
DecideNode
DirectoryEntry
EffectTool
EnforcementContext
EnforcementResult
EnforcementRule
EscalationConfig
EscalationRequest
EvalScenario
EvalTurn
ExtractionCapabilityConfig
ExtractionToolResponseEnvelope
FactMemoryServiceOptions
FileEntry
FileInit
FileSystem
FileSystemDirent
FinalResult
Flow
FlowPromptContext
FlowReconfigureTransition
Foundation
FoundationConfig
FsError
FsStat
GeminiFunctionDeclaration
GlossaryTerm
GrepHit
GroundingValidatorOptions
HandoffInputData
HandoffInputResult
HandoffRecord
HandoffResult
HarnessConfig
HarnessHooks
Hook
Hooks
HttpCallbackConfig
HttpParam
HttpToolConfig
HttpToolResult
Injection
InputProcessor
InputProcessorResult
InterruptionEvent
JudgeDimension
JudgeVerdict
KnowledgeEmbedderAdapter
KnowledgeProviderConfig
KnowledgeRetrievalResult
KnowledgeRetrieverAdapter
LazyFileEntry
MarkOutcomeToolResult
MemoryEntry
MemoryIngestionOptions
MemoryService
Metrics
MetricsConfig
MkdirOptions
ModerationGuardOptions
NodeGrounding
ObservabilityConfig
ObservabilityMetrics
OpenAIResponsesCompactOptions
OutputProcessor
OutputProcessorResult
OverflowRecoveryResult
ParsedDateResult
PersistedRun
PersistentMemoryBlock
PersistentMemoryConfig
PersistentMemoryStore
PersonaConfig
PersonaExperimentConfig
PersonaExperimentMetadata
PersonaExperimentResolution
PiiGuardOptions
PiiMatch
PiiScanResult
ProcessorContext
PromptInjectionGuardOptions
PromptSection
PromptTemplate
ReadFileOptions
RealtimeAudioClient
RealtimeAudioConfig
RealtimeEventMap
RealtimeSessionConfig
RealtimeSessionHandle
RealtimeToolResponse
RefineInput
RefinementCapability
RefinementStageResult
ReplyNode
ResolvedAgentWorkspace
ResolvedSelection
RetrievalCacheAdapter
RetrieveProvider
RmOptions
Route
RoutedPersistentMemoryStoreConfig
RunContext
RunOptions
RunSimulationSuiteOptions
RunState
RunStore
RuntimeLike
ScenarioScore
ScheduledJob
Scheduler
SearchMemoryRequest
SearchMemoryResponse
Session
SessionEndMetadata
SessionMetadata
SessionStore
SessionTelemetry
SessionTrace
Shell
ShellExecOptions
ShellResult
SignalDelivery
SimulatableRuntime
SimulateConversationOptions
SimulatedTranscriptTurn
SimulatedUserPersona
SimulationResult
SimulationScenario
SimulationSuiteResult
SkillLike
SkillMeta
SkillStoreLike
SkillWireAgent
SourceRef
Span
SpanEvent
StepRecord
StepResult
StopCondition
StopConditionResult
StreamCallbackConfig
StreamCallbackPayload
StreamCallbackSink
StreamOptions
SymlinkEntry
TextDriver
ToolCallRecord
ToolDeclaration
ToolDefinition
ToolExecutionContext
ToolExecutor
ToolGuideline
ToolPolicy
ToolWithFiller
TracingConfig
TurnEndHookResult
TurnHandle
TurnResult
TurnScore
TurnSummary
TurnUsage
ValidateInput
ValidationCapability
ValidationStageResult
VoiceRulesConfig
WakeDelivery
WakeJobPayload
WakeOptions
WakeRunnable
WiredAgentSkills
WorkingMemory
WorkingMemoryBlockSpec
WorkingMemoryConfig
WriteFileOptions
Type Aliases
ActionContext
AgentStreamPart
AgentWorkspaceConfig
AnthropicCacheTtl
AnyTool
AuditEntryType
AuditEscalationReason
BufferEncoding
CancellationReason
CapabilityAction
ChannelId
ChannelPolicyChange
CompactionResult
ConfirmVerdict
ConversationAuditEntry
ConversationAuditLog
ConversationEvent
ConversationOutcome
ConversationOutcomeMarkedBy
EscalationHandler
EscalationOutcome
EscalationReason
FileContent
FileSystemEntryType
FlowNode
FlowState
FsEntry
HandoffInputFilter
HarnessStreamPart
HttpMethod
InitialFiles
InjectableTimer
InjectionLevel
InjectionPriority
Instructions
KnowledgeChunk
KuralleDataParts
KuralleMetadata
KuralleUIMessage
LazyFileProvider
MemoryBlockScope
MemoryRouteFn
ParamType
PersonaExperimentCohort
PersonaLanguagePolicy
PersonaRegister
PersonaVoice
PiiDetector
ProcessorAction
RefineDecision
RouteCondition
SessionDurableRuns
SimulationEnd
SkillSource
Tool
ToolContext
ToolExecutionOptions
ToolSet
TraceStreamEvent
Transition
UserInputContent
ValidateDecision
Variables
BuiltinPersonas
commonDateExpressions
contentValidation
dateParser
DEFAULT_AUTO_LOAD_BLOCKS
DEFAULT_BLOCK_CHAR_LIMIT
DEFAULT_CHANNEL_POLICIES
DEFAULT_COMPACTION_KEEP_RECENT
DEFAULT_COMPACTION_TRIGGER_TOKENS
DEFAULT_CONTEXT_BUDGET
DEFAULT_HANDOFF_INSTRUCTION
DEFAULT_JUDGE_DIMENSIONS
defaultEnforcementRules
DURABLE_RUNS_KEY
handoffFilters
loggingHooks
OUTCOMES_MARK_TOOL_NAME
readBeforeEdit
SALES_AGENT_TEMPLATE
SUPPORT_AGENT_TEMPLATE
TRIAGE_AGENT_TEMPLATE
VOICE_CONTEXT_BUDGET
WAKE_JOB_KIND
Functions
action
aggregateScores
applyAnthropicCacheControl
applyChannelPolicy
applyPromptCache
buildEscalationRequest
buildMarkOutcomeTool
buildMemoryBlockTool
buildOpenAIResponsesProviderOptions
buildToolSet
collect
collectRegisteredNames
compactMessages
composeFilters
composePersonaPrompt
computeMessageHistoryBudget
confirmGate
consumeAllPendingUserInput
consumePendingUserInput
createDateParser
createDependencyRule
createFactMemoryService
createFlowTransition
createFlowTransitionWithNode
createFlowUpdate
createFoundation
createFsTool
createGroundingValidator
createHandoffTool
createHookRunner
createHttpTool
createInProcessScheduler
createJudge
createLoadMemoryTool
createLoggingHooks
createMetricsHooks
createModerationGuard
createModerationOutputGuard
createObservabilityHooks
createPiiInputGuard
createPiiOutputGuard
createPromptInjectionGuard
createPromptTemplate
createRateLimitRule
createRuntime
createScheduleFollowupTool
createSequentialLimitRule
createShellTool
createSupportAgentTemplate
createTool
createToolEnforcer
createToolWithFiller
createWakeJobRunner
decide
defineAgent
defineFlow
defineTool
ensureSessionMetadata
estimateMessagesTokens
estimateTokenCount
extractMemories
filterAuditEntries
formatDateForSpeech
formatMemoryWithBudget
formatTimeForSpeech
formatWorkingMemorySection
fsErrorCode
getAllTemplates
getDefaultChannelPolicy
getTemplate
harnessToUIMessageStream
hasMediaParts
hasPendingUserInput
isAbortSignal
isAnthropicLanguageModel
isContextOverflowError
isFinalResult
isFlowTransition
isFlowUpdate
isHandoffResult
isOpenAIResponsesModel
isSkillStore
isWakeJob
keepRecentMessages
listTemplates
loadWorkingMemoryBlocks
mergeUserInputContents
parseConfirmation
parseDate
parseDateRange
peekPendingUserInput
preloadMemoryContext
prepareSkillStore
recoverFromContextOverflow
redactPii
registerTemplate
removeKeys
removeToolHistory
reply
resolveAgentWorkspace
resolveChannelPolicy
resolvePersonaExperiment
resolveWorkingMemoryStore
reviveSession
runSimulationSuite
scanMemoryWrite
scoreTurn
setPendingUserInput
simulateConversation
toAISDKTools
toConversationOutcomeStreamPart
toGeminiDeclarations
toolToAiSdk
transcribeAudioParts
truncateToTokenBudget
userInputToText
validateSkillAllowedTools
wakeJob
wireAgentSkills
wireWorkingMemory
wrapAiSdkTool
@kuralle-agents/hono-server
@kuralle-agents/hono-server
Interfaces
ChatCompletionsRequest
CreateOpenAICompatRouterOptions
OpenAICompatRuntime
Type Aliases
ChatRequest
ChatResponse
FlowRequest
FlowResponse
HarnessStreamPart
KuralleChatRouterOptions
KuralleRouterOptions
KuralleSseChatRouterOptions
KuralleWebSocket
ResumeRequest
StreamEventFilter
UpgradeWebSocket
WebSocketEvent
WebSocketHandler
Functions
createKuralleChatRouter
createKuralleRouter
createKuralleSseChatRouter
createOpenAICompatRouter
sanitizeForClient
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
GitHub
Select theme
Dark
Light
Auto
DirectoryEntry
Properties
Section titled “Properties”
mode
Section titled “mode”
mode:
number
;
mtime
Section titled “mtime”
mtime:
Date
;
type
Section titled “type”
type:
"directory"
;