Quickstart

By the end of this guide you'll have an APIMatic portal running locally with interactive API reference docs, a live API playground, APIMatic SDKs in multiple languages, and language-specific guides.

PrerequisitesCopy Anchor Link

• Node.js v20 or later
• npm

1. Install the APIMatic CLICopy Anchor Link

npm install -g @apimatic/cli

Confirm the install:

apimatic --version

2. Log inCopy Anchor Link

apimatic auth login

Follow the browser prompt to sign in with your APIMatic email and password. Then check your session:

apimatic auth status

The output confirms your APIMatic account email and the SDK languages available on your plan (C#, Python, TypeScript).

3. Create a portal projectCopy Anchor Link

Make an empty directory for the project and move into it:

mkdir hello-apimatic
cd hello-apimatic

Launch the interactive setup:

apimatic quickstart

Choose API Documentation Portal from the menu. The wizard walks you through:

1. Importing your API definition
2. Choosing SDK languages
3. Scaffolding the project
4. Generating the portal files
5. Starting a local preview server

What's nextCopy Anchor Link

Your APIMatic portal is running. From here you can browse the generated API reference, try endpoints in the playground, download SDKs with code samples, and start customizing.

To start the preview server again later:

apimatic portal serve