Plain-English documentation

MagnetApi API and setup guide

This guide explains MagnetAPI.org in plain English: what the service does, how the dashboard works, how your System Token is used, how setup scripts are generated, how wallet credit is charged, and which customer API routes are available.

What MagnetApi is

MagnetAPI.org is a developer API aggregator. It gives you one account, one dashboard, and one System Token that can be used with supported coding clients and API routes. Instead of managing separate setup instructions for every tool, you choose a model in the dashboard and MagnetApi shows the matching setup path.

The service is designed for practical coding workflows. Your local client remains the place where files, shell commands, editor actions, and local tools run. MagnetApi handles authentication, model access, wallet usage accounting, setup instructions, usage records, and dashboard management.

One tokenYour System Token connects supported clients to MagnetApi without creating a new token for every tool.
Model choiceChoose a supported model label in the dashboard, then run the setup script for your operating system or app.
Usage visibilityThe dashboard shows recent request history, model labels, wallet charges, and remaining balance.

Quick start

Most users do not need to write API code manually. Sign in to your dashboard, choose the model you want to use, open Setup Wizard, choose your operating system or app, and copy the generated script. The script installs or configures the supported client and points it to MagnetApi using your current System Token.

  1. Open the Client Dashboard and sign in.
  2. Complete your profile if the dashboard asks for it.
  3. Open Model Choice and choose the model label you want to use.
  4. Open Setup Wizard, choose your app or operating system, and copy the script.
  5. Run the script in the terminal shown by the instructions, then open your project folder and start the coding client.

Tip: use the permanent System Key for your own setup scripts. Create separate User API Keys for web apps, external agents, servers, and integrations you may need to revoke independently.

System Token vs User API Key

Your dashboard shows a clear-text System Key. This is the permanent main account key used by setup scripts and coding clients. It cannot be removed or changed. User API Keys are separate, revocable credentials for direct API integrations, external agentic coding models, servers, and web applications.

NameUsed forManagement
System KeyDashboard setup scripts, Codex CLI, Claude Code, VS Code, OpenClaw, and primary account configuration.Permanent. It cannot be removed or changed.
User API KeyCustom applications, web apps, external coding agents, automation, servers, and SDK integrations.Create, copy, and revoke each key separately without affecting the System Key.

Treat every key like a password. Use a dedicated User API Key for each external integration so you can revoke one application without interrupting your main coding setup.

How are User API Keys billed?

Every User API Key belongs to the same MagnetAPI account and wallet as the System Key. Model calls use the same live internal token rates, transaction ledger, model access, and wallet balance. Creating another key does not create another wallet or duplicate credit.

Supported models

Model names are shown as customer-facing choices in the dashboard. Pick the model that best fits the job, then use the generated setup script for your local tool. The model choice can be changed later from the dashboard.

ModelBest fitNotes
GPT-5.6General coding, planning, fixes, and API-style work.OpenAI-compatible routes are available.
Opus 5Claude Code workflows, larger refactors, and agentic coding.Claude-compatible Messages routes are available.
Sonnet 5Fast Claude-compatible coding and iterative edits.Selectable from the dashboard when available for your account.
Fable 5Premium checks, high-value review, and verification passes.Displayed and billed as a premium model when selected.

Fable 5 is a premium model. When selected, dashboard usage records identify it as premium and show the relevant billing label for that request.

Setup scripts

The dashboard includes setup pages for Linux, Windows PowerShell, macOS, VS Code, OpenClaw, codexclaude, and VIP Server when your account has VIP access. Instructions appear above each script. The dark script box should contain only commands or configuration that can be copied.

Setup scripts are generated for your account and current System Token. If you change models, rotate your System Token, or activate VIP Server access, return to the dashboard and copy the latest script rather than using an older saved copy.

Which setup should I choose?

  • Choose Linux / Ubuntu / Debian when your project is on a Linux server, WSL, or a Linux desktop.
  • Choose Windows PowerShell when your project is on Windows and you want the CLI tools installed for your Windows user.
  • Choose macOS when your project is on a Mac terminal.
  • Choose VS Code when you want a VS Code custom language model or Codex-style provider configuration.
  • Choose OpenClaw when you use OpenClaw and want MagnetApi models registered there.
  • Choose codexclaude when you want one local app that can switch between supported model labels.

Which base URL should I expect?

OpenAI-compatible clients normally use https://api.magnetapi.org/v1. Claude-compatible clients normally use https://api.magnetapi.org. The dashboard scripts fill these in for you, so most customers should not type them manually.

Billing and API Coding Credit

API Coding Credit is an internal MagnetApi usage unit. It is used only inside MagnetApi to run supported coding models and is not cash, stored value, withdrawable money, or a bank balance.

Top-ups start from $5. The standard top-up rule is simple: every $1 paid loads $10 of API Coding Credit. Top-ups of $250 or more use the higher VIP tier rule of $1 paid loading $15 of API Coding Credit and can activate VIP Premium Server access for 30 days when the account qualifies.

The dashboard and checkout pages show how much API Coding Credit will be loaded before you pay. Each API request is measured across supported input, output, and cache categories using the live model rates. Usage history then records the customer-facing model, charge, and remaining balance so you can review the result.

Top-up amountCredit ruleExample
$5 to $249.99$1 paid loads $10 API Coding Credit.$5 loads $50 API Coding Credit.
$250 and above$1 paid loads $15 API Coding Credit.$250 loads $3,750 API Coding Credit.

The dashboard can also show trial credit, Daily Check-in rewards, VIP status, and any active Unlimited benefit when those account features apply.

Trial credit, Daily Check-in, Unlimited, and VIP

New account trial

New MagnetAPI accounts unlock $5 trial API Coding Credit after email verification. The credit is valid for 30 days from account creation. Verification also unlocks a 15-minute Unlimited Coding trial that starts when the first billable coding API request reaches MagnetAPI.

Daily Check-in rewards

Daily Check-in is available from the dashboard for users with at least $5 API wallet credit. The reward path is designed as a 30-day streak. Missing one day may allow a reduced recovery claim. The first two-day lapse restarts the path at Day 1; a second ends it until a qualifying $5 top-up resets the promotion.

Unlimited windows

If an account has an active Unlimited benefit, wallet credit is not deducted during that active Unlimited window. The timer starts when the first eligible coding API request reaches the server. The dashboard shows whether the window has not started, is active, or has expired.

VIP Premium Server

VIP access unlocks the Frankfurt priority endpoint for lower latency to European and UK customers. VIP users see a VIP Server section and setup wizard in the dashboard. When VIP expires, the normal MagnetAPI endpoint remains available as long as the account has wallet credit.

Customer API endpoints

The interactive API Reference shows the exact live customer schema. Admin routes are never published in this documentation or its OpenAPI file.

EndpointPurpose
POST /api/auth/registerCreate a MagnetAPI account from the public registration page.
POST /api/auth/loginDashboard sign-in using your username or email and password.
GET /api/meRead the current dashboard session account, setup data, and Daily Check-in status.
GET /api/v1/meRead account details using a bearer System Key or User API Key. Setup credentials are returned only for the System Key.
GET /api/v1/wallet/statusRead wallet credit status.
GET /api/v1/billing/token-usageRead recent usage and deduction history.
POST /api/v1/wallet/stripe/checkoutCreate a Stripe checkout session for top-up credit.
GET /api/setupRead setup scripts for the signed-in dashboard user.
POST /api/modelChange the dashboard model preference for generated setup scripts.
GET /api/v1/vipRead VIP status and VIP setup data when VIP access is active.
GET /v1/modelsList supported model labels for OpenAI-compatible clients.
POST /v1/responsesOpenAI-compatible Responses route for coding clients.
POST /v1/chat/completionsOpenAI-compatible Chat Completions route.
POST /v1/messagesClaude-compatible Messages route for Claude Code-style clients.
POST /v1/messages/count_tokensClaude-compatible token counting helper used by supported clients.

Request examples

Replace YOUR_SYSTEM_TOKEN with the System Token shown in your dashboard.

Wallet status

curl -fsS https://api.magnetapi.org/api/v1/wallet/status   -H "Authorization: Bearer YOUR_SYSTEM_TOKEN"

OpenAI-compatible chat completions

curl -fsS https://api.magnetapi.org/v1/chat/completions   -H "Authorization: Bearer YOUR_SYSTEM_TOKEN"   -H "Content-Type: application/json"   -d '{"model":"gpt-5.5","messages":[{"role":"user","content":"Say hello from MagnetApi"}]}'

Claude-compatible messages

curl -fsS https://api.magnetapi.org/v1/messages   -H "Authorization: Bearer YOUR_SYSTEM_TOKEN"   -H "Content-Type: application/json"   -H "anthropic-version: 2023-06-01"   -d '{"model":"claude-opus-5","max_tokens":128,"messages":[{"role":"user","content":"Say hello from MagnetApi"}]}'

Troubleshooting

401 token expired or invalid

Check that the System Token in your local config matches the clear-text System Token in the dashboard. If you rotated the token, rerun the setup script for the client you use.

404 Not Found

Confirm the base URL and endpoint. OpenAI-compatible clients usually use https://api.magnetapi.org/v1. Claude-compatible clients usually use https://api.magnetapi.org.

429 usage or access limit

Unlimited windows allow unlimited concurrent coding sessions while active. If you see a 429, check whether the Unlimited window has expired, whether the account is active, or whether an upstream model provider is temporarily rate-limiting requests.

The model says it cannot edit files

Local tools are controlled by your local client. Start the coding client inside the project folder and make sure the local app has permissions for Read, Write, Edit, Bash, Grep, Glob, and MCP tools where your workflow needs them.

VS Code says 401 or Not Found

Confirm that the token in the VS Code custom language model configuration matches the current System Token in the dashboard. Also confirm that the endpoint URL includes the correct route. For chat-completions style integrations, use https://api.magnetapi.org/v1/chat/completions.

Claude Code says the provider did not respond

First check your local network or VPN, then confirm the dashboard token and base URL. Claude-compatible setup should use https://api.magnetapi.org as the base URL and should not mix old API keys or stale tokens from another service.

PowerShell or npm errors

Run PowerShell as the normal Windows user who owns the project files. Make sure Node.js is installed and reopen the terminal after installation so the PATH refreshes.

Privacy and local tools

MagnetApi acts as an authenticated API gateway and usage ledger. Your local coding client remains responsible for local files, terminal commands, plugin execution, project history, and local tool permissions. The service records account, request, model label, usage, billing, security, and support data needed to operate the gateway.

The high-priority AWS and Azure API links are infrastructure paths for the service. Customers still use MagnetApi endpoints and do not need direct cloud credentials, cloud consoles, or cloud provider configuration to use the product.

Read the Privacy and GDPR Notice and Terms of Service for the formal policy details.

Need exact API fields? Open /api-docs, paste your System Token, and use the interactive reference.