Quick Start Guide#

This guide will help you get started with MetaBeeAI quickly.

Installation#

MetaBeeAI can be installed using pip. Open your terminal and run:

pip install metabeeai

For further options, including development installation, please refer to the Installation Guide

Configuration#

MetaBeeAI uses a flexible configuration system. Before running commands, set up your configuration:

  1. Copy the example config:

    cp config.example.yaml config.yaml

  2. Add your API keys (required for most operations):

    # Set as environment variables
export OPENAI_API_KEY=sk-your-key-here
export LANDING_AI_API_KEY=your-landing-key

    Or add them to config.yaml (but don’t commit this file!):

    openai_api_key: "sk-your-key-here"
landing_api_key: "your-landing-key"

  3. Customize paths (optional):

    data_dir: ./data
papers_dir: ./data/papers
log_level: INFO

For detailed configuration options and hierarchy, see the Configuration Guide.

Basic Usage#

Prepare Your PDFs#

Organize papers in data/papers/:

data/papers/
├── 4YD2Y4J8/
│   └── 4YD2Y4J8_main.pdf
├── 76DQP2DC/
│   └── 76DQP2DC_main.pdf
└── ...

Each paper should be in its own folder with a unique alphanumeric ID.

Run the Pipeline#

The full pipeline can be ran, using CLI commands:

metabeeai process-pdfs

For a detailed breakdown of the usage and options, please refer to the User Guide.

For the full API reference, please refer to the API Reference.