Home / Launchpad / Documentation

Quickstart Guide

This guide will walk you through creating your first developer portal with Launchpad. By the end, you'll have a fully functional API documentation site.

Prerequisites

Before you begin, you'll need:

  • A Launchpad account (request access at early access)
  • At least one OpenAPI specification (YAML or JSON)
  • Admin access to configure your portal

Step 1: Create Your Portal

After logging into the Launchpad management console, you'll be guided through the portal creation wizard.

  1. Click New Developer Portal from the dashboard
  2. Enter your Developer Portal Name and Developer Portal Slug
  3. Choose your GCP region for data residency
  4. Select your Developer Portal Capacity

Portal Provisioning

Portal provisioning typically completes within 2-5 minutes. You'll be notified when your portal is ready.

Step 2: Configure Branding

Customize your portal's appearance to match your brand identity.

  1. Navigate to Configuration → Theme
  2. Upload your logo (SVG recommended for best quality)
  3. Set your primary and secondary brand colors
  4. Optionally, use our AI Theme Generator to create a complete theme from your logo

The AI Theme Generator analyzes your logo and brand colors to automatically generate a cohesive color palette, typography settings, and component styles.

Step 3: Add API Specifications

Upload your OpenAPI specifications to create interactive API documentation.

  1. Go to API Specifications in the Admin sidebar
  2. Click Upload Specification
  3. Upload your OpenAPI file or paste a URL
  4. Set the title, description, version and select a category
  5. Click on Upload Specification
example-api.yaml 
openapi: 3.0.0
info:
  title: Example API
  version: 1.0.0
  description: A sample API for demonstration
paths:
  /users:
    get:
      summary: List all users
      responses:
        '200':
          description: Successful response

Supported Formats

Launchpad supports OpenAPI 3.0, OpenAPI 3.1, and Swagger 2.0 specifications.

Step 4: Create an API Product

API Products group related APIs together and define access policies.

  1. Navigate to API Products
  2. Click Add API Product
  3. Give your product a name and description
  4. Select which API Product to include
  5. Finally, click on save.

Step 5: Publish Documentation

Use the AI Page Builder to create additional documentation pages.

  1. Go to Page Builder in the sidebar
  2. Click New Page
  3. Choose from templates or start with AI assistance
  4. Add content blocks: text, code samples, images, and API references
  5. Click Publish when ready

Step 6: Invite Your Team

Add team members to collaborate on your portal.

  1. Navigate to Workspace → Team
  2. Select your Team
  3. Click Member tab
  4. Click Invite Member
  5. Enter their email address
  6. Assign appropriate roles (Admin, Editor, Viewer)

Next Steps

Now that your portal is set up, explore these advanced features: