ReadMe

ReadMe API

The ReadMe API (v2) lets you programmatically control your ReadMe developer hub. It manages API definitions, API reference pages, guides, changelog, custom pages, categories, branches (versions), images, recipes, and search. Authentication uses a Bearer API key.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.readme.com/main/reference/intro-to-the-readme-api
📖
Authentication
https://docs.readme.com/main/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/openapi/readme-openapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/graphql/readme-graphql.md

OpenAPI Specification

readme-openapi.yml Raw ↑