The everything docs platform.

Ask AI

What is ReadMe?

ReadMe makes it easy to create and publish beautiful, interactive API documentation.

Whether you want to work in our WYSIWYG editor or check-in your docs as you code, you can always keep docs in sync. ReadMe offers Git-style workflows with branching and versioning, built-in AI tools, and analytics to help you understand how developers use your API.

More information:

HomeGuidesRecipesAPI ReferenceChangelog

⌘K

Ask AI

JUMP TO

⌘/

Getting Started

Authentication

My Requests

Getting Connected 👋

Examples

About Owl APIs

Limiting API Results

API Updates

Owl Facts

Get owl facts

Add owl fact

Delete owl fact

Update owl fact

Get owl factAsk AI

POST

https://owlstore.readme.com/v3/facts/

Example Owl Facts

The tiniest owl, the Elf Owl, is only 5 inches tall.

A group of owls is called a parliament.

Owls can turn their heads as much as 270 degrees. They're owlways watching you.

BODY PARAMETERS

int64

quantity

int64 • default 100

The number of facts you want.

fun_facts

boolean • default true

If false, excludes the fun facts.

LANGUAGE

Shell

Node

Ruby

PHP

CREDENTIALS

Basic

••••1114

REQUEST

curl --request GET \

--url https://travel.hoot.at/api/v1/tours \

--header 'accept: application/json' \

--header 'authorization:••••1114'

RESPONSE

[
{ "id": "111424", "fact": "Owls are farsighted..." } ]

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

Recipes

Step-by-step guides that highlight code for your APIs and SDKs.

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

Guides

WYSIWYG editor that's backed by markdown and JSX.

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

API Reference

Automatically generated reference from your API specification.

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

Changelog

Keep users updated with your latest releases and fixes.

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

Discussions

Community-driven support for your product.

1export const ExampleComponent = ({ children }) => {2 return (3 <div className="flex items-center...">4 <div className="bg-gray-800...">5 {children}6 </div>7 </div>8 );9};

Landing Page

Customizable landing page for your product.

All the building blocks for great docs.

+40 Widgets

Customize your documentation with 40+ different widgets.

YouTubeEmbed YouTube videos.

ImageUpload images to your docs.

MermaidMake diagrams and charts.

GitHub GistEmbed code snippets.

Callouts

Highlight important information with callouts.

🫐Blueberrys Today

Accordion

Display collapsible content with an accordion.

Secret Owl Fact

Tabs

Display content in a tabbed interface.

Owl Fact

Bear Fact

Your API is under bear-y close observation.

Columns

Display content in a column layout.

Ask AI

Chat-based AI assistant for your docs.

AI Dropdown

Shortcuts to ask LLMs about your docs.

Run in Postman

Bring your Postman collections to your users.

Code

Syntax-highted code snippets for 60+ languages.

const readme = require("readme");
const getUser = (email) => {
  return users.find({ email });
};

Copy

Checklist

Create a todo lists to guide your users.

Create a new project

Generate API key

Tables

Create tables with ease.

Parameter	Type	Default
firstName	string	"Owlbert"
location	string	"37.78..."
email	string	"owlbert..."

Cards

Highlight key features with cards.

Cards

Highlight key features with cards.

Reusable Content

Create reusable content blocks.

Blueberries

Used in 3 pages

🫐Blueberrys Today

Blockquote

Add quotes to your docs.

The night owl gets the worm.

Terminal

Terminal widget for example snippets.

Terminal

$ npm install -g readme

Statuspage

Keep your users informed via Statuspage.

System Status

Database

API

Core Services

Add Your Own

Our Editor is built with MDX and supports Tailwind, so you can add your own.

A powerful AI editor that's always in sync.

Git-backed Docs

No matter where your team writes, everything stays in sync.

AI-backed Linter

A customizable style guide to keep your docs consistent.

Score 8.6/10

Save

Fix Issues

Passive VoicePassive voice detected: 'The configuration file can be created.' Use active voice: 'Create the configuration file.' for clarity.
Example IntegrityA variable user_id is used in the code block without being defined previously on this page.

AI Docs Audit

Voice, terminology, and structure at scale with automated audits.

Name	Score	Errors	Warnings
OAuth Workflows	9.0/10	3	5
API Migration Guide	9.0/10	3	5
Versioning	8.0/10	3	5
Accessibility Compliance	7.0/10	3	5
Technical FAQ	3.0/10	3	5

AI Writing Agent

The doc-writing assistant that's always editing and improving your docs.

Initialized Request

You got it, I've formatted the page content with bullet points to enhance readability.

agent-owlbert.mdx+1 lines-1 lines

## What It Can Do

The AI Agent provides comprehensive documentation assistance like:|content|editing; research & analysis; smart components; and multi-step workflows.creation &

The AI Agent provides comprehensive documentation assistance like:* Contentcreation & editing * Research & analysis * Components * Multi-step workflows

## Getting Started