Jump to Content

Customer Stories ReadMe Blog

Guides Recipes API Reference Changelog Discussions

API Reference

Jump to Content

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 Keys
API Reference
APIs
Apply to ReadMe
- Get open rolesget
- Submit your application!post
Branches
Categories
Changelog
Custom Pages
Guides
Images
IP Addresses
- Get ReadMe's outbound IP addressesget
Owlbot AI
- Ask Owlbot AI a questionpost
Projects
- Get project metadataget
Recipes
Search
- Perform a search queryget

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

Legacy API

Limiting API Results
API v1 → v2 Update Guide
API Registry
- Retrieve an entry from the API Registryget
API Specification
Categories
Changelog
Custom Pages
Docs
IP Addresses
- Get ReadMe’s outbound IP addressesget
Owlbot AI
- Ask Owlbot AI a questionpost
Projects
- Get metadata about the current projectget
Version

Powered by

Legacy API
API Specification

Get our OpenAPI Definition

get

https://dash.readme.com/api/v1/schema

Returns a copy of our OpenAPI Definition.

Language

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