Jump to Content

Customer Stories ReadMe Blog

Guides Recipes API Reference Changelog Discussions

Customer Stories ReadMe Blog Log In

API Reference

Guides Recipes API Reference Changelog Discussions

All

Pages

Start typing to search…

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 Registryget
API Specification
Apply to ReadMe
- Get open rolesget
- Submit your application!post
Categories
Changelog
Custom Pages
Docs
IP Addresses
- Get ReadMe’s outbound IP addressesget
Projects
- Get metadata about the current projectget
Version
Owlbot AI
- Ask Owlbot AI a questionpost

Developer Metrics API

Metrics API Introduction
API Logs
- Send an API Log to ReadMepost
Page Quality
Page Views
Search
- Get top search termsget
- Get data by search termget

ReadMe API v2 🦉 (BETA)

API Reference
APIs
Changelog
- Get all changelog entriesget
- Get a changelog entryget
Custom Pages
Guides
Projects
- Get project metadataget
Search
- Perform a search queryget
API Keys
Categories
Apply to ReadMe
- Get open rolesget
- Submit your application!post
Changelog
IP Addresses
- Get ReadMe's outbound IP addressesget

Search docs

post https://dash.readme.com/api/v1/docs/search

Returns all docs that match the search.

Language

Credentials

Basic

base64

:

Click Try It! to start a request and see the response here!