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

ExecOutput

What an adapter's exec returns: the complete output as byte streams, never truncated or buffered whole.

The framework's sandbox layer consumes them into an ExecResult.

Fields

exit_codePromise<number>required

Resolves once both streams end.

stdoutAsyncIterable<Uint8Array>required

Byte chunks: TS AsyncIterable<Uint8Array>, Python AsyncIterator[bytes].

stderrAsyncIterable<Uint8Array>required

Byte chunks, as stdout.

SandboxSession

One live sandbox, as an adapter returns it from create, restore or attach: run commands, move files, snapshot and close it.

ExecResult

What tools and the log see.

On this page