OpenMagic OpenMagic API Unified access for modern AI workflows
Login Open client setup
Docs / Agent Starter

From “I want to try AI coding” to the first working Agent workflow.

This page does more than tell existing users where to paste a Base URL. It helps new users pick a popular tool, copy one command, and complete the first useful task.

Open client setup Open console

First, be clear: the Agent guides are not all finished yet.

The first high-priority set is available now: Codex, Claude Code, Cline, Roo Code, Continue, Cursor, LobeChat/NextChat, and Windsurf. Screenshot-level guides, version differences, mirror packages, and more tools will continue to be added.

Install strategy

How OpenMagic should be connected first.

Current strategy: prioritize platforms by user volume: Windows PowerShell first, macOS second, Linux/WSL third. Third-party tools should be installed from official npm/GitHub sources. OpenMagic provides local bootstrap scripts that write the Base URL, API key, model suggestions, and setup notes.

Why not modify third-party packages directly: repackaging tools creates copyright, update, and security risk. Start with one-click configuration. Later we can add official package mirrors, pinned versions, hash checks, and preconfigured templates without asking users to install unknown modified packages.

Network optimization: scripts are hosted on OpenMagic itself, so users only need access to api.openmagic.ai. Slow npm/GitHub downloads can be handled later with cached mirrors and offline package indexes.

Run it in 4 steps

The shortest useful path.

1. Create account

Create an account with email and password.

2. Subscribe

Start with a low-friction plan.

3. Copy key

Copy your API key from Console.

4. Copy command

Pick an Agent below and click Copy.

Choose your Agent

Pick one, do not compare forever.

Ready · OpenAI-compatible

Codex CLI

Terminal coding agent for reading, editing, and testing code.

Best for: Beginner friendly

Windows PowerShell (recommended)

$env:OPENMAGIC_API_KEY="sk-om-..."; iwr https://api.openmagic.ai/assets/install/openmagic-agent-setup.ps1 -UseB | iex

macOS

OPENMAGIC_API_KEY="sk-om-..." bash <(curl -fsSL https://api.openmagic.ai/assets/install/openmagic-agent-setup.sh) codex

Linux / WSL

OPENMAGIC_API_KEY="sk-om-..." bash <(curl -fsSL https://api.openmagic.ai/assets/install/openmagic-agent-setup.sh) codex

Manual configuration

OPENAI_API_KEY=sk-om-... OPENAI_BASE_URL=https://api.openmagic.ai/v1 codex

Note: Start with a small folder. Ask it to explain before editing.

First task templates

Copy a safe first prompt.

Read the current directory and tell me how to start this project, its main directories, and its risk points. Do not modify files.

Read the current directory and tell me how to start this project, its main directories, and its risk points. Do not modify files.

Fix this error. Before making changes, explain which files will be touched, and run tests after the changes.

Fix this error. Before making changes, explain which files will be touched, and run tests after the changes.

Generate the install and run sections of the README from the current code, keeping it concise.

Generate the install and run sections of the README from the current code, keeping it concise.

Write a script that checks dependencies, environment variables, and port usage. Do not delete any files.

Write a script that checks dependencies, environment variables, and port usage. Do not delete any files.

Safety boundaries

New users need to see this before the first run.

Rule Reason
Do not paste production keys into public issues or screenshots. A leaked API key can create real cost.
Use a low-quota key for the first run. This limits waste if a tool loops or retries incorrectly.
Ask the Agent to explain its plan before editing files. This reduces accidental deletion and broad refactors.
Do not approve delete/reset commands you do not understand. Be especially careful with git reset, rm -rf, and database drop commands.
Agent setup Start now