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

Doc

One admitted document version, as KnowledgeProvider.get returns it.

Its bytes are an artifact in the store, named by content_ref.

Fields

doc_idstringrequired

The document's id.

versionstringrequired

The version asked for.

media_typestringrequired

The document's media type, as it was ingested.

content_refArtifactRefrequired

Content-addressed bytes.

bindingBindingrequired

Issued by the host; the provider stores it opaquely.

KnowledgeHit

One matching passage, as a provider returns it from search.

SearchBackend

A web_search backend adapter (Exa, Brave, Tavily).

On this page