Skip to content
Studio previewSelf-host Studio locally.Run it

Installation

Updated 8 days ago • October 29, 2026

Prerequisites

  • Node.js 20+
  • pnpm (recommended in this monorepo)
  • Zod ^4.5.0 (Zod 4.5 or later within major version 4)

Install the main package

pnpm add kortyx "zod@^4.5.0"

If you prefer scoped packages, see Package Overview.

Runtime dependency notes

Zod is a peer dependency of Kortyx and the schema-based scoped packages. Keep one compatible Zod version shared by your application and the SDK. Separate versions can cause TypeScript schema errors even when both are Zod 4. If your application already uses Zod ^4.5.0, it can keep that version; you do not need to upgrade to the latest release. Zod 3 and Zod 4.0–4.4 are unsupported.

kortyx already re-exports agent/runtime/hooks/providers/stream APIs.

You still need provider credentials at runtime (for example Google):

export GOOGLE_API_KEY=your_key_here