Quickstart

APItoGo turns your API into a product: a developer portal with docs and an API reference, a gateway that checks API keys and limits, sign-in for your users, and plans they pick. One file, apitogo.config.json, describes it all, and the apitogo CLI builds and deploys it.

Prerequisites

• Node.js 20+
• The apitogo CLI, installed globally: npm install -g @lukoweb/apitogo (see Install the CLI)
• An account on apitogo.com (needed to deploy, not to try it locally)

Get started

1. Create the project

   Code
   apitogo create --template full

   It asks for a name, makes a folder for it and writes everything a working product needs:

   • apitogo.config.json with a portal, a gateway, sign-in and plans
   • a home page, a footer, a theme and a first docs page in apitogo/portal/
   • a small Node.js API in server/ with its OpenAPI file
   • apitogo/plans.json with starter plans you can change

   Run create without --template to pick the services one at a time instead.

2. Preview it locally

   Code
   cd <your project folder>
   apitogo run

   Open http://localhost:3000. The console signs in with a demo account (demo@apitogo.local / password), so you can try the pricing, plans and API keys pages before anything is deployed. Edit the pages in apitogo/portal/ and the preview updates.

3. Sign in to APItoGo

   Code
   apitogo login

   A browser window opens; sign in there.

4. Deploy

   Code
   apitogo deploy

   The first deploy creates the project (it asks which hosting plan: Free, Starter or Professional), then sets up each service and prints the addresses:

   Code
   portal: deployed to production (https://<name>.apitogo.com)
   gateway: deployed (https://<name>.api.apitogo.com/)

5. Try it as your users will

   Open the portal, create an account, pick the Free plan, create an API key on the API keys page, and call your API through the gateway with it.

What's next

• Configuration overview: every section of apitogo.config.json
• Portal: docs, home page, footer, logo and theme
• Plans and Set up Stripe for paid plans
• Walkthrough: the same journey one service at a time, with a customer's first call
• CLI commands

With an AI agent

The APItoGo MCP server lets an agent such as Claude Code or Cursor run the same steps for you. See Configure MCP in your agent.