agent-zero/docs/guides/onboarding.md
Alessandro 818bda0385
Some checks are pending
Build And Publish Docker Images / plan (push) Waiting to run
Build And Publish Docker Images / build (push) Blocked by required conditions
Document first-run onboarding flow
Add a screenshot-led guide for the guided onboarding wizard using Agent Zero API as the example setup. Link the guide from the docs hub, quickstart, and installation setup flow, and include optimized screenshots for choosing Cloud, selecting a provider, choosing models, and reaching the ready state.
2026-05-09 08:05:09 +02:00

2.9 KiB

First-Run Onboarding

Use onboarding the first time you open Agent Zero, or any time the Web UI says your models still need setup. The wizard helps you pick a provider, add the needed key or connection, choose the main model, choose the utility model, and start chatting.

This example uses Agent Zero API with a fake demo key and claude-opus-4-6. Replace the demo key with your own key.

Choose Cloud Or Local

Open the Web UI and click Start Onboarding from the welcome banner. On the first screen, choose whether Agent Zero should use a hosted provider or a local model server.

Onboarding start screen with Cloud and Local choices

Choose Cloud when you want to use Agent Zero API, OpenRouter, Anthropic, OpenAI, Google, Venice, or another hosted provider. Choose Local when you want to connect to Ollama, LM Studio, or another model server running on your machine.

Pick Agent Zero API

On the Cloud provider screen, click Agent Zero API.

Cloud provider picker with Agent Zero API

The ChatGPT/Codex account option is also available on this Cloud screen if you want to connect by device code instead of pasting a provider key.

Add The Key And Main Model

Paste your Agent Zero API key in API key. The screenshot uses a fake example key, and the field is masked.

Click the magnifier in Main model to open the model list, then choose claude-opus-4-6.

Agent Zero API setup with model dropdown open

After the model is selected, click Choose utility model.

Agent Zero API setup with key and main model selected

Choose The Utility Model

The utility model handles supporting work such as summarizing, organizing memory, and other background tasks.

Leave Use same as Main Model checked if you want both roles to use claude-opus-4-6.

Utility model step using the same model as main

You can also uncheck Use same as Main Model and choose a different utility provider and model. For example, you might keep a strong main model for chat and use a faster or cheaper model for utility tasks.

Click Finish setup when the utility model looks right.

Start Chatting

The ready screen confirms that model setup is done. Optional setup cards may appear for integrations such as Telegram, Email, WhatsApp, or plugins.

Onboarding ready screen after setup

Click Start Chatting to create a chat and begin using Agent Zero.

Important

Do not reuse the fake key shown in this guide. Paste your own provider key, and do not share screenshots that reveal real keys or private account details.