How to Use

Docs

The simplest agent framework to build 'Secure, Safe and Responsible' GenAI apps faster

Introduction

Lyzr

Discover the key differentiators that set Lyzr apart in the GenAI agent landscape.

Why Lyzr?

What Makes Lyzr Unique

Explore all the powerful GenAI use cases Lyzr enables through its flexible agent framework.

What You Can Build

Get up and running with Lyzr Agent Studio in under a minute

Quick Start

An introduction to Lyzr and a high-level overview of building agents with Lyzr.

Basic Overview

Understanding the core components of Lyzr’s agent framework and Studio.

Components

Agent Building

Guide to using Lyzr's powerful REST API for building and managing AI agents.

How to Use - API

Models

Detailed overview and use cases of OpenAI models integrated with Lyzr

OpenAI

OpenAI Models

Anthropic Claude models available in Lyzr and their ideal use cases

Anthropic

Amazon Bedrock models available in Lyzr and how to configure them for enterprise-scale AI agents

AWS Bedrock

AWS Bedrock Models

Gemini models from Google available in Lyzr and their use case guidance

Google

Google Models

Perplexity AI models available in Lyzr with recommended use cases and capabilities

Perplexity

Perplexity Models

Groq-hosted LLMs available in Lyzr with ultra-fast performance, ideal for real-time agent interactions

Groq

Groq Models

Key terminology and definitions for Lyzr Agent Studio and generative AI concepts.

Glossary

Overview of Retrieval-Augmented Generation and how Lyzr leverages it for accurate, context-rich responses.

Retrieval-Augmented Generation (RAG)

Lyzr’s built-in Responsible AI features ensure safe, fair, and compliant agent behavior.

Responsible AI

Deep dive into Lyzr’s Manager Agent for dynamic multi-agent orchestration.

Manager Agent

Join the Lyzr community on Slack and GitHub to connect, contribute, and collaborate.

Join Us

Join the Lyzr Community

Need Help?

Getting Support

FAQs

Accounts & Billing

Team Management

Comprehensive overview of Lyzr, including Studio and API components.

Overview

Deep Dive

Agents

Steps to create, update, and delete agents in Lyzr Agent Lab

Studio

Managing Agents in Lyzr Agent Studio

Learn how to launch and publish your Lyzr agent to make it available privately, publicly, or within your organization.

Publish Agent

Publishing Agents in Lyzr

Overview of Lyzr's Knowledge Base (KB), its capabilities, supported formats, and RAG integration for AI-powered retrieval and response generation.

Knowledge Base

Semantic Model

Semantic Model In Lyzr

No code Knowledge Base

Memory Management Introduction

Short-Term Memory

Long-Term Memory

Available Tools

Ready Tools

Custom Tools

Custom Tool Creation Using Studio

How Lyzr ensures responsible, secure, and ethical AI for enterprises

Enforce ethical AI usage with automated protections for content moderation, privacy, and compliance in your Lyzr agents.

Safe AI Studio

Safe & Responsible AI

Introduction to LAO

What is Manager Agent

What is DAG?

How to use

Manager Agent in Lyzr Agents

Use Case

Multi-Channel Customer Support

Workflow

Lyzr Agent Orchestration (LAO) Workflow

Best Practices

Manager Agent Best Practices

Make Lyzr agents available as MCP servers

Lyzr Agents as MCP Servers

Setup

Usage

Lyzr - NANDA

Lyzr - NANDA MCP Server Cookbook

Learn how to build a software manager agent using multi agent orchestration

Lyzr - Software Manager

Join Discord

Lyzr Agent Framework

Cookbooks

Book Demo

Blog

Industries

Studio Build Path

API Build Path

Lyzr Agents API

Retrieves all agents associated with a given API key. This is useful for managing multiple agents and checking their configurations.

Get Agents By API Key

Create Agent

Perform a chat interaction with an agent using the inference engine (v3).

Chat

Chat With Agent

Start a streaming chat interaction with an agent using the v3 inference stream endpoint.

Chat Streaming

Stream Chat

Retrieve a specific version of an agent using agent ID and version ID.

Agent Version

Get Agent Version

Retrieve a list of all versions for a given agent.

List Agent Versions

Agent versions

Creates a new agent specifically for a single-task operation.

Create Single Task Agent

Retrieve agent details using the agent ID.

Get Agent by ID Endpoint

Updates the configuration of an existing agent.

Update Agent Endpoint

Delete Agent Endpoint

Updates an existing single-task agent with new configuration details.

Update Single Task Agent Endpoint

Creates a new RAG configuration using LLM, embedding, and vector store credentials.

Create RAG Configuration

Get RAG configuration

Update the configuration for an existing RAG setup by providing the config ID and updated values.

Update RAG Configuration

Deletes an existing RAG configuration by its ID.

Delete RAG Configuration

Create Documentation Agent

Fetches documentation agents for the authenticated user.

Get Documentation Agent

Connect Database to RAG

Connect Database to RAG Endpoint

Saves documentation for a specific table to the vector store.


Save Documentation Endpoint

Save Documentation Agent

Initiates an asynchronous task to save table documentation including descriptions and a data preview.


Async Save Documentation

Asynchronous Endpoint To Save Documentation Task

Get Table Names

Get Table Names Endpoint

View Table Data

Preview Table Data

Gmail

📧 Gmail Integration with Lyzr

Slack

Slack Integration with Lyzr

ClickUp

✅ ClickUp Integration with Lyzr

Notion

🧠 Notion Integration with Lyzr

Outlook

📬 Outlook Integration with Lyzr

Google Calendar

📆 Google Calendar Integration with Lyzr

Google Drive

☁️ Google Drive Integration with Lyzr

Google Tasks

✅ Google Tasks Integration with Lyzr

Calendly

📅 Calendly Integration with Lyzr

GitHub

🛠️ GitHub Integration with Lyzr

Discord

💬 Discord Integration with Lyzr

Twitter (X)

🐦 Twitter (X) Integration with Lyzr

Spotify

🎧 Spotify Integration with Lyzr

YouTube

📺 YouTube Integration with Lyzr

Perplexity AI

🔍 Perplexity AI Integration with Lyzr

Retrieves all tools associated with a user.

Get User Tools

Create OpenAPI Tool Endpoint

Fetches detailed information about a specific OpenAPI tool.

Get OpenAPI Tool Info

Executes a specific OpenAPI tool using provided parameters.

Execute OpenAPI Tool

Get Tool Endpoint

This endpoint allows updating an existing tool's configuration.

Update Tool Endpoint

Delete Tool Endpoint

Toggle Tool

Create Tool Credential Endpoint

Update an existing tool credential by its ID.

Update Tool Credential Endpoint

Delete Tool Credential Endpoint

Create RAI Policy

Get all RAI policies for the authenticated user.