Quick Start Guide

Get your first API deployed in under 5 minutes with Apx.

Prerequisites

Node.js 18+ or Python 3.9+

An Apx account (sign up at apx.dev)

Basic understanding of REST APIs

Installation

Install the Apx CLI
npm install -g @apx/cli

Or using pip
pip install apx-cli

Authentication

Login to your Apx account
apx login

Verify your authentication
apx whoami

Your First API

Create a simple API using natural language:

apx create "A user management API with JWT authentication"

The Builder Agent will:

1. Generate the API schema

2. Configure security policies

3. Set up authentication

4. Deploy to production

Test Your API

Get your API endpoint
apx list

Test the endpoint
curl https://your-api.apx.dev/v1/users \
  -H "Authorization: Bearer YOUR_TOKEN"

Next Steps

[Configure authentication](#authentication)

[Set up monitoring](#monitoring)

[Scale your API](#scaling)