Chapter 2

Getting started

Welcome to LocalAI! This section takes you from a fresh install to a working chat, a working API call, and your first customized model. Follow the pages in order the first time through; each one builds on the previous.

Tip

Haven’t installed LocalAI yet?

See the Installation guide first. Docker is the recommended installation method for most users.

The path

  1. Install LocalAI (see the Installation guide).
  2. Quickstart - start LocalAI, install your first model, and get your first chat reply from both the web interface and the API.
  3. Install and run models - the different ways to install models (gallery, Hugging Face, OCI, local files) and run them.
  4. Try it out - copy-paste examples for every OpenAI-compatible endpoint (chat, vision, functions, audio, images, embeddings).
  5. Customize models - edit model configuration and prompt templates to tune behavior.
  6. Troubleshooting - fixes for the most common install and startup problems.

Once you have a model answering, the Build your first agent walkthrough shows how to turn that model into an autonomous agent that can use tools.