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.
Documentation
Documentation
https://docs.readme.com/main/reference/intro-to-the-readme-api
Authentication
https://docs.readme.com/main/reference/authentication
Specifications
Other Resources
GraphQL
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/graphql/readme-graphql.md
APIsJSON
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/apis.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-create-branch-with-guide-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-create-category-with-guide-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-publish-changelog-post-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-publish-custom-page-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-publish-recipe-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-release-version-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-submit-metrics-and-audit-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-upload-api-definition-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-upsert-category-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-upsert-changelog-post-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-upsert-custom-page-workflow.yml
Arazzo
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/arazzo/readme-upsert-guide-workflow.yml