Skip to main content

​
Overview

The BudAI Foundry SDK is the official Python SDK for the BudAI Foundry Platform. It provides:
  • Full-featured client library for the BudAI Foundry API
  • OpenAI-compatible inference endpoints (chat, embeddings, classifications)
  • DAG-based pipeline definition and execution
  • Command-line interface (bud CLI) for pipeline operations
  • Both synchronous and asynchronous client support
  • Complete type hints with Pydantic models

​
Requirements

  • Python: 3.8 or higher
  • pip: Latest version recommended

​
Install from GitHub

Install directly from the GitHub repository: 
pip install git+https://github.com/BudEcosystem/BudAIFoundry-SDK

​
Install from Source

Clone and install from source: 
git clone https://github.com/BudEcosystem/BudAIFoundry-SDK
cd BudAIFoundry-SDK
pip install -e .

​
Verify Installation

Verify the SDK is installed correctly: 
from bud import BudClient

client = BudClient()
print("BudAI Foundry SDK installed successfully!")
Verify the CLI is available: 
bud --version

​
What’s Included

After installation, you have access to:

​
Python SDK

  • BudClient - Main client for API interactions
  • Pipeline, Action - DAG-based pipeline builders
  • Type-safe models and schemas
  • Async client support

​
CLI Tool

  • bud auth - Authentication management
  • bud pipeline - Pipeline operations
  • bud run - Execute pipelines
  • bud execution - View execution history
  • bud action - List available actions

​
Next Steps

Quickstart

Get started with your first API call

Authentication

Configure authentication methods

CLI Reference

Learn CLI commands

Examples

View code examples