Guides API Reference HTTP API

Functions

agent tool extension mcp secret openThread / open_thread sqlite localMemory / local_memory localKnowledge / local_knowledge scriptedModel / scripted_model fakeSandbox / fake_sandbox host

Agents and runs

Agent RunResult RunStream RunContext Tool McpServer Extension Hooks Skill Secret Store ConfigError ConfigErrorCode

Threads and evals

Thread CaseExpectation SavedCase

Host

Model adapters

Model ModelContext ModelInfo ModelRequest ModelResponse ModelChunk LookupResult LookupCapability

Sandbox adapters

Sandbox SandboxAuthority SandboxContext SandboxInfo SandboxSession ExecOutput ExecResult

Memory and knowledge adapters

MemoryProvider KnowledgeProvider Scope Binding MemoryRecord RecordRef MemoryHit KnowledgeSource DocVersion KnowledgeHit Doc SearchBackend SearchHit

Channel adapters

ChannelAdapter ChannelCapabilities RawRequest RawResponse VerifiedDelivery Inbound DeliveryOutcome

SavedCase

What saveCase returns: where the case was written and whether it replays anywhere.

Fields

pathstringrequired

The case directory that was written, <dir>/<name>.

portablebooleanrequired

false when the case depends on a named provider.

CaseExpectation

Written into case.json.

Host

TS: supports await using (Symbol.asyncDispose calls stop).

On this page