docs
Getting Started
Quick Start

Quick Start

Get started with Zomma Labs in minutes. This guide will walk you through installing the SDK and running your first query.

Prerequisites

Installation

Install the Zomma Labs SDK using pip:

pip install zomma-labs

Or with all optional dependencies:

pip install zomma-labs[full]

Authentication

Set your API key as an environment variable:

export ZOMMA_API_KEY="your-api-key-here"

Or authenticate programmatically:

import zomma
 
zomma.api_key = "your-api-key-here"

Your First Query

Example 1: Query Knowledge Graph

Query the knowledge graph for information about a company:

from zomma import KnowledgeGraph
 
kg = KnowledgeGraph()
 
# Query facts about Apple Inc
facts = kg.query(
    entity="Apple Inc",
    fact_type="REPORTED_FINANCIALS",
    time_range=("2023-01-01", "2024-01-01")
)
 
for fact in facts:
    print(f"{fact.timestamp}: {fact.text}")

Example 2: Run an Agent Simulation

Use the Agentic OS to simulate a scenario:

from zomma import Agent
 
agent = Agent()
 
# Ask a scenario question
result = agent.simulate(
    question="What happens to my tech-heavy portfolio if the Fed raises rates by 100bps?",
    portfolio={"AAPL": 0.3, "MSFT": 0.25, "GOOGL": 0.25, "NVDA": 0.2}
)
 
print(result.analysis)
print(f"Estimated impact: {result.portfolio_impact}%")

Next Steps

Now that you're set up, explore more capabilities:

  • Knowledge Graph API - Learn about entity resolution, fact extraction, and graph queries
  • Agentic OS API - Build sophisticated financial reasoning agents
  • MCP Server - Integrate with Claude Desktop and other MCP clients

Getting Help

IntroductionKnowledge Graph API