Quickstart

Get your API documentation live in three steps.

Step 1: Create Your Project

1. Sign into your ReadMe account.
2. Click Create New Project.
3. Name your project.
4. Upload your logo — ReadMe matches your brand colors automatically.

Step 2: Add Your API Spec

Upload your OpenAPI specification to generate an interactive API reference with endpoint descriptions, request/response examples, and a built-in API explorer.

After upload, you'll see a preview of your endpoints and documentation structure. Click Go to Docs to see the live result.

No OpenAPI file yet? Click Skip to Docs — you can add one later from project settings.

Step 3: Write Your First Guide

Guides are the pages that sit alongside your API reference — getting started tutorials, authentication walkthroughs, and conceptual explanations. You have two ways to create them:

Option A: Use the Agent

Open the Agent from the chat icon in your editor. Describe what you need and the Agent will draft it, pulling from your uploaded API spec for accuracy.

Try a prompt like:

• "Write a getting started guide for my API"
• "Create an authentication walkthrough with code examples"
• "Draft a guide explaining our webhook system"

The Agent writes in Markdown with ReadMe's MDX components. Review the output, edit as needed, and save.

Option B: Write in the Editor

1. Toggle into Edit Mode from the top navigation.
2. Click + NEW CATEGORY and name it (e.g., "Getting Started").
3. Click + next to the category to create a page.
4. Type / to insert code blocks, callouts, images, tabs, and other components.
5. Toggle between Edit and View to preview.

What's Next