Skip to content

API Reference

The API Reference documents runtime functions and extension points. For frontmatter fields and data shapes, use the generated Schema Reference.

PageWhat it covers
Pipeline Functionsload, render, parse, prepare, run, invoke, process, and input validation
Agent Turnsturn, tool dispatch, loop limits, and agent-mode error handling
Tool CallingTool callable registration, kind handlers, dispatch order, and bindings
Connection RegistryRegistering named clients/configuration for connection.kind: reference
StreamingStream options, raw streaming responses, and processed chunks
Structured Outputoutputs, StructuredResult, cast, and typed invocation helpers
TracingTracer registration and tracing custom operations
ReferenceUse it for
Schema Reference.prompty frontmatter fields, runtime model types, tools, events, and protocol data shapes
Prompty SpecificationRuntime behavior requirements and cross-runtime semantics
Implementation GuidesRuntime-specific package names, provider coverage, and implementation notes
Discover Available ModelsProvider model/deployment listing helpers returning ModelInfo records