Developing with Zep

Learn how to install and use Zep SDKs for Python and TypeScript

You are viewing the Zep Open Source v0.x documentation. This version is no longer supported, and documentation is provided as a reference only.

The current documentation for Zep Community Edition is available here.

Installation

Zep offers both Python and TypeScript SDKs.

Python

$pip install "zep-python>=1.5.0,<2.0.0"

TypeScript

$npm install @getzep/zep-js@^0.10.0

or

$yarn add @getzep/zep-js@^0.10.0

Initializing the Client

Note: Zep supports optional JWT authentication.

The examples below assume that you have enabled JWT authentication. See the Authentication Configuration Guide for more information.

Python

1from zep_python import ZepClient
2
3# Replace with Zep API URL and (optionally) API key
4zep = ZepClient("http://localhost:8000", api_key="optional_api_key")

TypeScript

1import { ZepClient } from "@getzep/zep-js";
2
3// Replace with Zep API URL and (optionally) API key
4const zep = ZepClient.init("http://localhost:8000", "optional_api_key");

Note: zep-python supports async use

zep-python supports async use. All methods are available as both sync and async, with the async methods prefixed with a. For example, zep-python has both zep_client.memory.add_memory and zep_client.memory.aadd_memory methods.

Next Steps

Now that you have a Zep client, you can start using the Zep APIs.

  • Working with Chat History

    Store Chat History, enrich it with metadata, and run semantic search over messages and summaries.