Jump to Content
Customer Stories
ReadMe Blog
Guides
Recipes
API Reference
Changelog
Discussions
Customer Stories
ReadMe Blog
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Guides
Recipes
API Reference
Changelog
Discussions
Apply to ReadMe
All
Pages
Start typing to search…
JUMP TO
Getting Started
Authentication
My Requests
ReadMe API 🦉
Intro to the ReadMe API
Limiting API Results
API v1 → v2 Migration Guide
API Registry
Retrieve an entry from the API Registry
get
API Specification
Get metadata
get
Upload specification
post
Update specification
put
Delete specification
delete
Get our OpenAPI Definition
get
Apply to ReadMe
Categories
Get all categories
get
Create category
post
Get category
get
Update category
put
Delete category
delete
Get docs for category
get
Changelog
Get changelogs
get
Create changelog
post
Get changelog
get
Update changelog
put
Delete changelog
delete
Custom Pages
Get custom pages
get
Create custom page
post
Get custom page
get
Update custom page
put
Delete custom page
delete
Docs
Create doc
post
Search docs
post
Get doc
get
Update doc
put
Delete doc
delete
Get production doc
get
IP Addresses
Get ReadMe’s outbound IP addresses
get
Owlbot AI
Ask Owlbot AI a question
post
Projects
Get metadata about the current project
get
Version
Get versions
get
Create version
post
Get version
get
Update version
put
Delete version
delete
Developer Metrics API
Metrics API Introduction
API Logs
Send an API Log to ReadMe
post
Page Quality
Get average page quality
get
Get best pages
get
Get page comments
get
Get worst pages
get
Get page breakdown
get
Page Views
Get difference in page views
get
Get top pages
get
Get total page views
get
Get unique page views
get
Get users
get
Get page views per day
get
Get views by path
get
Search
Get top search terms
get
Get data by search term
get
ReadMe API v2 🦉 (BETA)
API Keys
Create an API key
post
Get your API keys
get
Delete an API key
delete
Get an API key
get
Update an API key
patch
API Reference
Create a reference page
post
Get a reference page
get
Delete a reference page
delete
Update a reference page
patch
APIs
Get all API definitions
get
Create an API definition
post
Get an API definition
get
Update an API definition
put
Delete an API definition
delete
Validate an API
post
Apply to ReadMe
Get open roles
get
Submit your application!
post
Branches
Get branches
get
Create a branch
post
Get a branch
get
Updates an existing branch
patch
Delete a branch
delete
Categories
Create a category
post
Delete a category
delete
Update a category
patch
Changelog
Get a changelog entry
get
Get all changelog entries
get
Create a changelog entry
post
Update a changelog entry
patch
Delete a changelog entry
delete
Custom Pages
Create a custom page
post
Get all custom pages
get
Get a custom page
get
Delete a custom page
delete
Update a custom page
patch
Guides
Create a guides page
post
Get a guides page
get
Delete a guides page
delete
Update a guides page
patch
Images
Get uploaded images
get
Upload an image
post
Get an image
get
IP Addresses
Get ReadMe's outbound IP addresses
get
Owlbot AI
Ask Owlbot AI a question
post
Projects
Get project metadata
get
Recipes
Get all recipes
get
Create a recipe
post
Get a recipe
get
Delete a recipe
delete
Update an existing recipe
patch
Search
Perform a search query
get
Prefetch
Ask AI
Apply to ReadMe
