Skip to main content
The Sample App Generator lets you create a library of pre-built sample applications that showcase common use cases for your API. Developers can explore, fork, and customize these examples.

​
How It Works

1

You create sample apps

Use prompts or build manually to create examples for common use cases.
2

Developers browse your library

A gallery of ready-to-run examples organized by use case.
3

They fork and customize

Developers copy examples and modify them for their needs.

​
Key Features

Curated Examples

Hand-picked examples that showcase your API’s best features.

Multiple Use Cases

Cover different scenarios: authentication, data fetching, webhooks, etc.

Fork & Edit

Developers get their own copy to customize and deploy.

Always Up-to-Date

Update examples when your API changes—all forks stay independent.

​
Creating Sample Apps

​
From the Dashboard

1

Go to Sample Apps

Navigate to Sample Apps → Create New in your dashboard.
2

Choose a method

  • Generate with AI: Enter a prompt describing the app - Import from GitHub: Import an existing repository - Start from scratch: Build manually in the playground
3

Configure metadata

Add a title, description, and tags for discoverability.
4

Publish

Make the sample app available in your library.
Create examples for these common scenarios:
CategoryExample Apps
Getting StartedHello World, Authentication, First API Call
Core FeaturesCRUD Operations, Pagination, Error Handling
Use CasesDashboard, Form Submission, Data Export
AdvancedWebhooks, Real-time Updates, Batch Operations

​
Organizing Your Library

​
Tags and Categories

Organize sample apps with tags:
  • By feature: authentication, webhooks, pagination
  • By framework: react, python, node
  • By difficulty: beginner, intermediate, advanced
Pin your best examples to the top of the library for new developers.

​
Integration

Sample Apps generated can be embedded in the following places:
  • Documentation platforms: Mintlify, Fern, Astro Starlight, ReadMe, GitBook
  • Websites: Any existing website or developer portal
  • Post-login experiences: API portals, dashboards, onboarding flows

​
Analytics

Track how developers interact with your sample apps:
  • Views: How many developers viewed each app
  • Forks: How many created their own copy
  • Time Spent: Average time in the playground
  • Popular Apps: Which examples get the most engagement
Access analytics in Dashboard → Analytics.

​
Best Practices

Start with simple examples: authentication, first API call, basic CRUD. Then add advanced scenarios.
Each sample app should demonstrate one concept well. Don’t try to show everything in one app.
Explain what each example does and when developers would use it.
Keep examples current with your API. Outdated samples frustrate developers.

​
Next Steps

Guided Sandbox

Create step-by-step interactive tutorials.

Customization

Brand your sample app library.