Getting Started

Welcome to the InvokeAI Python Client! This guide will help you get up and running quickly.

Overview

The InvokeAI Python Client enables you to:

1. Export workflows from the InvokeAI GUI
2. Load them in Python with full type safety
3. Set parameters programmatically
4. Execute at scale with batch processing
5. Map outputs to generated images

Prerequisites

Before you begin, ensure you have:

• Python 3.9 or higher
• InvokeAI server running (default: http://localhost:9090)
• A workflow exported from the InvokeAI GUI

Quick Navigation

• Installation

  Set up the client in your environment

• Quick Start

  Run your first workflow in 5 minutes

• Core Concepts

  Understand the key ideas behind the client

Typical Workflow

flowchart LR
    A[Design in GUI] --> B[Export JSON]
    B --> C[Load in Python]
    C --> D[Set Parameters]
    D --> E[Submit Batch]
    E --> F[Map Outputs]
    F --> G[Download Images]

What's Next?

Start with Installation to set up the client, then follow the Quick Start guide to run your first workflow.

For a deeper understanding of how the client works, read Core Concepts.