APX

Quick Start Guide

Get up and running with APX in 5 minutes

quick-start tutorial

Get Started in 5 Minutes

This guide will help you set up your APX account and run your first API test session.

Step 1: Create Your Account

  1. Visit app.apxlabs.ai
  2. Click “Start Free Trial”
  3. Sign in with Google OAuth

You’ll be automatically signed in and redirected to the APX workspace.

Step 2: Create Your First Project

Projects help you organize your APIs and test sessions.

  1. Click the “Create Project” button in the welcome screen
  2. Enter a project name (e.g., “My First Project”)
  3. Optionally add a description
  4. Click “Create”

Step 3: Add Your First API

  1. Click the Add API button in the floating action bar (left sidebar)
  2. Enter your API details:
    • Name: A friendly name for your API
    • Endpoint: The base URL of your API
    • Version: API version (optional)
  3. Click “Add API”

Your API will appear in the context panel (middle section).

Step 4: Start an Agent

Before you can test your API, you need to start an agent:

  1. Find your API in the context panel
  2. Click the Start Agent button
  3. Wait for the agent status to show “Running” (usually takes 2-3 seconds)

Step 5: Create Your First Session

Now you’re ready to test!

  1. Click on your API in the context panel to open the API detail view
  2. Click the New Session button
  3. Select a mission profile (start with “Exploration” for general testing)
  4. Your session will open in a new tab in the main stage area

Step 6: Interact with Your API

In the session view:

  • Enter API requests in the chat interface
  • Ask the agent to test specific endpoints
  • Explore API behaviors and responses
  • View real-time results

What’s Next?

Now that you’ve run your first session, explore these guides:

Need Help?

Last updated: January 18, 2025