Every public class, function and type of the criogenai TypeScript package (0.1.7), one page per module, generated from its declarations and doc comments every time the site is built. Install it with npm install criogenai. The same API in Python and Rust.
New to CriogenAI? Start with the quickstart and the agents guide; come here for the exact names, parameters and defaults.
Agents#
| Page | What it covers | Main names |
|---|
| Agents | The agent: a model, tools and instructions; runs, threads, streams and approvals. | Agent, AgentOptions, Thread, Stream |
| Tools | Functions the model can call: definitions, input schemas, errors and the tool context. | tool, Tool, ToolDefinition, ToolError |
| Hooks | Your code around the agent loop: before and after model and tool calls. | HookContext, HookAction, ToolCall, ToolResult |
| Errors | Every error class, one per stable error code. | CriogenError, NativeUnavailableError, ModelError, ToolExecutionError |
| Usage and cost | Tokens and an estimated price for a run. | ModelUse, RunFacts, Price, estimateCost |
Models#
| Page | What it covers | Main names |
|---|
| Models | Providers and models: OpenAI, Anthropic, Gemini, Azure, Bedrock, Vertex AI, local servers and more. | openai, anthropic, gemini, FakeModel |
| Gateway | Chat, stream and embed without an agent, with retries and fallbacks. | Gateway, ChatInput, ChatOptions, ChatReply |
| Keys and environment | Loading API keys from a file or the environment. | parseEnv, LoadEnvOptions, loadEnv, envStatus |
| Redaction | Removing personal data before anything reaches a provider. | Redactor |
Data#
| Page | What it covers | Main names |
|---|
| Storage and memory | Durable threads (SQLite, Postgres, in memory), encryption, audit, retention and long-term memory. | Storage, Memory, StorageOptions, MemoryOptions |
| Collections | Documents to search by meaning, and a retrieval tool for agents. | Collection, CollectionOptions, Document, Hit |
Orchestration#
| Page | What it covers | Main names |
|---|
| Workflows | Graphs of steps and agents: routes, joins, loops, pauses for people, and threads. | Workflow, CompiledWorkflow, WorkflowThread, END |
| Patterns | Ready-made multi-agent designs: sequential, parallel, loops, routers, debates and more. | sequential, parallel, loop, custom |
| Specialist agents | Default agent recipes (researcher, writer, critic, ...) and a registry for your own. | SpecialistSettings, ExtendOptions, Specialist, register |
Integrations#
Quality and operations#
| Page | What it covers | Main names |
|---|
| Telemetry | Exporting runs to Langfuse or any OpenTelemetry backend. | Telemetry, TelemetryOptions |
| Trace viewer | A local page that shows your runs, with no account. | serveTraces, TraceViewer, TraceViewerOptions |
| Evals | Datasets, scorers, judges, comparisons and quality gates. | evaluate, Dataset, EvalResult, compare |
| Readiness check | Checks that the engine, keys and providers work before you ship. | ready, ReadyReport, ReadyOptions |