Home / Launchpad / Documentation

Interactive API Documentation

Launchpad uses Scalar to provide beautiful, interactive API documentation. Developers can explore endpoints, understand schemas, and test API calls directly in the browser.

Features

API Explorer

The API explorer provides a comprehensive view of your APIs:

  • Endpoint List — Organized by tags with search
  • Method Badges — Color-coded HTTP methods
  • Request Details — Parameters, headers, and body schemas
  • Response Examples — Expected responses with schemas
  • Authentication — Security requirements clearly shown

Try It Now

Developers can test APIs without leaving the documentation:

  • Fill in parameters with form fields
  • Auto-populate with example values
  • Execute requests in real-time
  • View formatted responses
  • See request timing and headers

Sandbox Mode

Enable sandbox mode to let developers test APIs without affecting production data.

Code Generation

Generate code snippets in multiple languages:

  • cURL
  • JavaScript (Fetch, Axios)
  • Python (requests, http.client)
  • Node.js
  • Ruby
  • PHP
  • Go
  • Java
  • C#
  • Swift
  • Kotlin

Authentication

Supported Methods

Scalar supports all common authentication methods:

  • API Key — Header, query, or cookie
  • Bearer Token — JWT or opaque tokens
  • OAuth 2.0 — Full OAuth flow support
  • Basic Auth — Username/password

Authentication Persistence

Once authenticated, credentials persist:

  • Saved in browser local storage
  • Automatically applied to requests
  • Clear button for logging out
  • Multiple credential sets supported

Configuration

Theme Customization

Scalar automatically inherits your portal theme:

  • Brand colors applied
  • Font families matched
  • Dark/light mode supported
  • Custom CSS overrides available

Layout Options

  • Default — Sidebar navigation with main content
  • Modern — Three-column layout
  • Classic — Traditional two-column

Content Options

Configure what's shown in the documentation:

  • Show Examples — Display example values
  • Show Schemas — Inline schema definitions
  • Show Authentication — Security requirements
  • Show Servers — Available server URLs
  • Enable Try It — Interactive testing

Advanced Features

Full-text search across all API documentation:

  • Search endpoints by name, description, or path
  • Search parameters and schemas
  • Keyboard shortcut (Cmd/Ctrl + K)
  • Highlighted results

Deep Linking

Every element has a shareable URL:

  • Link to specific endpoints
  • Link to parameters
  • Link to schemas
  • URLs update as you navigate

Markdown Support

Rich formatting in descriptions:

  • Headers and paragraphs
  • Code blocks with syntax highlighting
  • Tables
  • Lists
  • Links and images
  • Callouts and admonitions

Mobile Experience

The API documentation is fully responsive:

  • Optimized for tablets and phones
  • Touch-friendly navigation
  • Collapsible sections
  • Full Try It functionality on mobile

Embedding

In Portal Pages

Embed API reference in your custom pages:

  • Full API reference embed
  • Single endpoint embed
  • Schema-only embed
  • Try It widget embed

External Embedding

Embed documentation in external sites:

  • iframe embed code
  • Script embed for dynamic loading
  • Web component for React/Vue apps

Export Options

Export documentation for offline use:

  • HTML — Static HTML site
  • PDF — Printable documentation
  • Postman Collection — Import into Postman
  • Insomnia Collection — Import into Insomnia