Skip to main content
LlamaIndex is a framework for building LLM-powered applications. This guide shows how to use the llama-index-tools-ceramic package to give a LlamaIndex agent access to Ceramic Search.

Get your Ceramic API key

Create a free account to get started.

​
Building agents

The CeramicToolSpec wraps Ceramic Search as a LlamaIndex tool. Pass it to any LlamaIndex agent and the agent will call it automatically when it needs to retrieve information.

​
Set environment variables

export CERAMIC_API_KEY=your_ceramic_api_key
export OPENAI_API_KEY=your_openai_api_key

​
Install dependencies

python
pip install llama-index-tools-ceramic llama-index-llms-openai

​
Full example

python
import asyncio
import os
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI
from llama_index.tools.ceramic import CeramicToolSpec

ceramic_tool = CeramicToolSpec(api_key=os.environ["CERAMIC_API_KEY"])

agent = FunctionAgent(
    tools=ceramic_tool.to_tool_list(),
    llm=OpenAI(model="gpt-5.4"),
)

async def main():
    response = await agent.run("What are the latest California tenant protection laws?")
    print(response)

asyncio.run(main())

​
Run the example

python
python llamaindex_agent.py

GitHub

View source code

PyPI

View package