Lyzr Agent API

Name: Lyzr Agent API
Brand: Lyzr Agent API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAI/MLLanguage ModelsapiKey16 EndpointsREST

For Agents

Create Lyzr AI agents (general or single-task), open conversational sessions, exchange messages, and pull session history, summaries, and full transcripts.

Install Jentic One Beta

Connect the Lyzr Agent API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Lyzr Agent API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Lyzr Agent API.

Create and update users that own sessions and agents via POST /v1/users/ and PUT /v1/users/{user_id}

Open a session against a specific agent with POST /v1/sessions/{agent_id} and manage its lifecycle (get, update, delete)

Pull a session's running history, the auto-generated summary, and the full conversation via dedicated endpoints

GET STARTED

Start building with Lyzr Agent API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Lyzr Agent API for, with concrete tasks.

★ Embed a Lyzr conversational agent inside a product

Product teams use Lyzr as a managed agent runtime instead of wiring their own LLM orchestration. POST /v3/agents/ creates a configured agent, POST /v1/sessions/{agent_id} opens a session for a user, and the session's GET history, GET summary, and GET conversation endpoints power the chat UI. This avoids hosting a vector store, prompt template engine, and message log in-house.

POST /v3/agents/ to create an agent, POST /v1/sessions/{agent_id} to open a session for the user, and GET /v1/sessions/{session_id}/conversation to render the chat history.

Single-task agents for narrow workflows

Rather than configuring a fully general agent, narrow workflows like 'classify this email' or 'summarise this ticket' use POST /v3/agents/template/single-task to spin up a focused agent in one call. This cuts setup time from minutes to seconds and gives the operations team a clean separation between the chat-style assistants and the back-office classifiers.

POST /v3/agents/template/single-task with the task description 'summarise customer support ticket' and return the new agent_id.

Session summary and conversation export

After an agent session, downstream tools (CRM, BI, QA review) need either a digest or the full transcript. GET /v1/sessions/{session_id}/summary returns the auto-generated digest, GET /v1/sessions/{session_id}/conversation returns the full message log, and GET /v1/sessions/{session_id}/history returns the running history during the session. This pattern keeps human reviewers in the loop without slowing down the conversation itself.

Pull GET /v1/sessions/{session_id}/summary to get the digest, then GET /v1/sessions/{session_id}/conversation if a human reviewer wants the full transcript.

Agent-driven Lyzr orchestration via Jentic

An autonomous agent is asked to spin up a domain-specific Lyzr agent, run a session, and post the summary into Slack. Jentic stores the Lyzr Authorization API key in MAXsystem and exposes the agent-create, session-create, and session-summary operations by intent so the calling agent can chain them without holding the raw key.

Search Jentic for 'create lyzr single-task agent', execute it with the task description, then chain POST /v1/sessions/{agent_id} and GET /v1/sessions/{session_id}/summary.

Key Endpoints

16 endpoints — jentic publishes the only available openapi specification for lyzr agent api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/users/

Create a user

POST

/v1/sessions/{agent_id}

Open a session against a specific agent

GET

/v1/sessions/{session_id}/conversation

Get the full conversation for a session

GET

/v1/sessions/{session_id}/summary

Get the auto-generated session summary

POST

/v3/agents/

Create an agent

POST

/v3/agents/template/single-task

Create a single-task agent from a template

GET

/v3/agents/

List agents in the workspace

POST

/v1/users/

Create a user

POST

/v1/sessions/{agent_id}

Open a session against a specific agent

GET

/v1/sessions/{session_id}/conversation

Get the full conversation for a session

GET

/v1/sessions/{session_id}/summary

Get the auto-generated session summary

POST

/v3/agents/

Create an agent

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Lyzr Authorization API key is stored encrypted in the Jentic MAXsystem vault. Jentic attaches it as the Authorization header on every request to agent.api.lyzr.app, keeping the raw key out of the agent's context.

Intent-based discovery

Agents search by intent such as 'create lyzr agent', 'open lyzr session', or 'get session summary', and Jentic returns the matching Lyzr operation with its parameter schema for direct execution.

Time to first call

Direct Lyzr integration: 1-3 days to wire authentication, model the user/session/agent hierarchy, and stream conversation history. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Lyzr Agent API through Jentic.

Why is there no official OpenAPI spec for Lyzr Agent API?

Lyzr does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Lyzr Agent API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Lyzr Agent API use?

Lyzr Agent API uses an Authorization header carrying an API key. Send the key as the Authorization value on every request to agent.api.lyzr.app. Through Jentic, the key is stored encrypted in MAXsystem and injected per request so it never enters the agent's prompt.

Can I spin up a single-purpose agent quickly?

Yes. POST /v3/agents/template/single-task creates a focused agent in one call rather than walking through the full agent configuration. Use this when the workflow is narrow — classify an email, summarise a ticket, draft a reply — and you do not need a general conversational agent.

What are the rate limits for the Lyzr Agent API?

Specific rate limits are not declared in this spec. Expect per-account limits tied to your Lyzr plan and the cost of underlying model inference — design clients to back off on 429 responses and avoid creating sessions in tight loops.

How do I get the summary of a Lyzr session through Jentic?

Search Jentic for 'lyzr session summary', load GET /v1/sessions/{session_id}/summary, and execute it with the session_id. Jentic injects the Authorization API key automatically and returns the auto-generated digest you can post into Slack or a CRM note.

Lyzr Agent API

Connect the Lyzr Agent API to your agent

Capabilities

Start building with Lyzr Agent API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs