ReadMe
ReadMe is a developer hub platform that helps companies design, document, and operate their APIs. The platform combines hosted API reference (OpenAPI-driven), guides and changelog, bi-directional Git sync (GitHub and GitLab), interactive API explorer, Try-It console, Developer Dashboard with real-time API logs, and a deep layer of AI tooling — including the ReadMe Agent for multi-page editing, Inline AI rewrites, the AI Linter for style-guide enforcement, Docs Audit, GitHub AI Writer for PR-triggered doc updates, Ask AI for end users, and Model Context Protocol (MCP) servers for both ReadMe itself and each customer project so AI tools can search, read, update docs, and call APIs.
ReadMe publishes 13 APIs on the APIs.io network, including Personalized Docs Webhook, Analytics API, API Keys API, and 10 more. Tagged areas include Documentation, Developer Hub, API Reference, Portals, and Analytics.
The ReadMe catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 3 Spectral governance rulesets.
ReadMe’s developer surface includes authentication, developer portal, getting-started guide, documentation, API reference, pricing, signup flow, and 38 more developer resources.
Kin Score
APIs 14
Individual APIs this provider publishes, each with its own machine-readable definition.
ReadMe MCP Server
ReadMe operates a hosted Model Context Protocol (MCP) server that lets AI tools (Claude, Cursor, IDEs, CI pipelines) search, read, and update ReadMe documentation through natura...
ReadMe Personalized Docs Webhook
ReadMe's Personalized Docs Webhook is the outbound, customer-hosted webhook the developer hub calls at user sign-in to look up a reader's account data. ReadMe POSTs a JSON body ...
ReadMe Analytics API
Page view, quality, and search analytics
ReadMe API Keys API
Manage ReadMe API keys
ReadMe APIs API
Manage API definitions and reference pages
ReadMe Branches API
Manage versions and branches
ReadMe Categories API
Manage sidebar groupings
ReadMe Changelog API
Manage changelog posts
ReadMe Custom Pages API
Manage custom documentation pages
ReadMe Guides API
Manage knowledge base guide pages
ReadMe Images API
Upload and manage images
ReadMe Metrics API
Send API request metrics from server-side SDKs
ReadMe Recipes API
Manage interactive recipe content
ReadMe Search API
Search knowledge base content
Scroll for all 14
Open Collections 2
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
ReadMe Developer Metrics API
OPEN COLLECTIONReadMe API
OPEN COLLECTIONArazzo Workflows 12
Multi-step API workflows described with the Arazzo specification.
ReadMe Stand Up A New Version With Starter Docs
Create a branch (version), add a category, and seed it with a first guide.
ARAZZOReadMe Create A Category With A Guide
Create a sidebar category and immediately add a guide page to it.
ARAZZOReadMe Cut A Version And Announce It
Create a branch, upload its API definition, and post a launch changelog.
ARAZZOReadMe Submit Metrics And Audit Quality
Send API request logs to Metrics, then retrieve page quality scores.
ARAZZOReadMe Upload An API Definition And Verify
Upload an OpenAPI definition to a branch and read the created definition back.
ARAZZOReadMe Upsert A Category
Find a category by slug and update it if it exists, otherwise create it.
ARAZZOReadMe Upsert A Changelog Post
Find a changelog post by slug and update it if it exists, otherwise create it.
ARAZZOReadMe Upsert A Custom Page
Find a custom page by slug and update it if it exists, otherwise create it.
ARAZZOReadMe Upsert A Guide Page
Find a guide by slug and update it if it exists, otherwise create it.
ARAZZOScroll for all 12
GraphQL 1
GraphQL schemas published by this provider.
ReadMe GraphQL API
GRAPHQLPricing Plans 1
Published pricing tiers and plan structures.
Readme Plans Pricing
PLANSRate Limits 1
Documented rate limits and quota policies.
Readme Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals for API financial operations.
Readme Finops
FINOPSEvent Specifications 1
AsyncAPI definitions for this provider's event-driven and streaming APIs.
ReadMe Personalized Docs Webhook
AsyncAPI 2.6 description of ReadMe's Personalized Docs Webhook surface. The Personalized Docs Webhook is the integration that lets ReadMe inject a logged-in end user's account d...
ASYNCAPISemantic Vocabularies 1
JSON-LD contexts and semantic vocabularies used across these APIs.
Readme Context
JSON-LDSpectral Rules 3
Spectral governance rulesets for linting and validating these APIs.
JSON Schema 5
Standalone JSON Schema definitions for this provider's data models.
ReadMe API Definition
JSON SCHEMAReadMe Branch
JSON SCHEMAReadMe Changelog Post
JSON SCHEMAReadMe Guide
JSON SCHEMAReadMe Metrics Request Log
JSON SCHEMAJSON Structure 1
JSON Structure definitions describing this provider's data shapes.
Readme Developer Hub Structure
JSON STRUCTUREExamples 5
Example request and response payloads for these APIs.
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
Recommended x-agentic-access execution contracts for AI agents.
Resources
Get Started 4
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 15
Pagination, idempotency, versioning, errors, and events
Scroll for all 15
Build 8
SDKs, sample code, and the tooling you integrate with
Scroll for all 8
Access & Security 2
Authentication, authorization, and security posture
Operate 3
Status, limits, changes, and where to get help
Commercial 5
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 1
Properties that don't map to a standard resource type