Skip to content
Prompty

API Reference

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

Page What it covers
Pipeline Functions load, render, parse, prepare, run, invoke, process, and input validation
Agent Turns turn, tool dispatch, loop limits, and agent-mode error handling
Tool Calling Tool callable registration, kind handlers, dispatch order, and bindings
Connection Registry Registering named clients/configuration for connection.kind: reference
Streaming Stream options, raw streaming responses, and processed chunks
Structured Output outputs, StructuredResult, cast, and typed invocation helpers
Tracing Tracer registration and tracing custom operations
Reference Use it for
Schema Reference .prompty frontmatter fields, runtime model types, tools, events, and protocol data shapes
Prompty Specification Runtime behavior requirements and cross-runtime semantics
Implementation Guides Runtime-specific package names, provider coverage, and implementation notes
Discover Available Models Provider model/deployment listing helpers returning ModelInfo records