Palt.io Documentation

Everything you need to know about creating, customizing, and publishing your API documentation with Palt.io.

Introduction

Palt.io is a modern API documentation platform designed to transform your OpenAPI (Swagger) specifications into beautiful, interactive, and user-friendly documentation websites. We believe that great APIs deserve great documentation, and developers shouldn't have to spend hours fighting with static site generators or writing docs from scratch.

Key Features

Instant Transformation

Upload your OpenAPI JSON or YAML file, and we instantly generate a fully functional documentation site.

Advanced Customization

Match your brand guidelines with our comprehensive theming system. Customize colors, fonts, and dark mode.

Interactive Playground

Let users test your API endpoints directly from the browser with our built-in 'Try It' console.

Custom Domains

Host your documentation on your own domain (e.g., docs.yourcompany.com) with automatic SSL.

How It Works

1

Create a Project

Sign up for an account and create a new project. Give your project a name and a unique slug (e.g., my-api-docs). This slug will be used for your default documentation URL (e.g., palt.io/docs/my-api-docs).

2

Import Your Spec

Upload your OpenAPI 3.0+ specification file (JSON or YAML). Our system validates the file and automatically parses your endpoints, schemas, parameters, and descriptions.

3

Customize & Branding

Head to the project dashboard to customize the look and feel.

  • Set primary, background, and accent colors for both light and dark modes.
  • Configure separate colors for HTTP methods (GET, POST, etc.).
  • Add your company logo.
4

Publish & Share

Your documentation is live instantly. You can now share the URL with your users or configure a custom domain to host it on your own infrastructure.

Security & Privacy

We take security seriously. All documentation is served over HTTPS with automatic SSL certificates. We do not store your API keys or sensitive data from your users' requests—our proxy service simply relays requests to your API endpoints ensuring CORS compatibility.

Ready to build better docs?