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.

4 APIs 0 Features

DocumentationDeveloper HubAPI ReferencePortalsAnalyticsAIMCPBi-Directional Sync

APIs

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, br...

ReadMe Developer Metrics API

The ReadMe Developer Metrics API powers the Developer Dashboard. It accepts API request logs from Metrics SDKs (Node.js, Python, Ruby, PHP, .NET) and exposes analytics including...

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 ...

Collections

ReadMe Developer Metrics API

OPEN

ReadMe API

OPEN

Arazzo Workflows

ReadMe Stand Up A New Version With Starter Docs

Create a branch (version), add a category, and seed it with a first guide.

ARAZZO

ReadMe Create A Category With A Guide

Create a sidebar category and immediately add a guide page to it.

ARAZZO

ReadMe Publish A Changelog Post

Create a changelog post on a branch and read it back by slug.

ARAZZO

ReadMe Publish A Custom Page

Create a custom page on a branch and read it back by slug.

ARAZZO

ReadMe Publish A Recipe

Create an interactive recipe and read it back by slug.

ARAZZO

ReadMe Cut A Version And Announce It

Create a branch, upload its API definition, and post a launch changelog.

ARAZZO

ReadMe Submit Metrics And Audit Quality

Send API request logs to Metrics, then retrieve page quality scores.

ARAZZO

ReadMe Upload An API Definition And Verify

Upload an OpenAPI definition to a branch and read the created definition back.

ARAZZO

ReadMe Upsert A Category

Find a category by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Changelog Post

Find a changelog post by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Custom Page

Find a custom page by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Guide Page

Find a guide by slug and update it if it exists, otherwise create it.

ARAZZO

GraphQL

ReadMe GraphQL API

GRAPHQL

Pricing Plans

Readme Plans Pricing

3 plans

PLANS

Rate Limits

Readme Rate Limits

2 limits

RATE LIMITS

FinOps

Readme Finops

FINOPS

Event Specifications

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...

ASYNCAPI

Semantic Vocabularies

Readme Context

35 classes · 0 properties

JSON-LD

API Governance Rules

ReadMe API Rules

9 rules · 5 errors 4 warnings

SPECTRAL

JSON Structure

Readme Developer Hub Structure

0 properties

JSON STRUCTURE

Example Payloads

Readme Create Changelog Example

2 fields

EXAMPLE

Readme Create Guide Example

2 fields

EXAMPLE

Readme List Apis Example

2 fields

EXAMPLE

Readme Metrics Request Example

2 fields

EXAMPLE

Readme Search Example

2 fields

EXAMPLE

Resources

PostmanWorkspace

PostmanWorkspace

GettingStarted

Documentation

APIReference

TermsOfService

PrivacyPolicy

GitHubAction

Marketplace

JSONLDContext

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: ReadMe API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: APIs
    type: folder
  items:
  - info:
      name: List API Definitions
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/apis
      params:
      - name: branch
        value: ''
        type: path
      - name: perPage
        value: ''
        type: query
      - name: page
        value: ''
        type: query
    docs: Retrieve metadata for API definitions on a branch.
  - info:
      name: Upload An API Definition
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches/:branch/apis
    docs: Upload An API Definition
  - info:
      name: Get An API Definition
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/apis/:id
      params:
      - name: branch
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Get An API Definition
  - info:
      name: Update An API Definition
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch/apis/:id
      params:
      - name: branch
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Update An API Definition
  - info:
      name: Delete An API Definition
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch/apis/:id
      params:
      - name: branch
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Delete An API Definition
- info:
    name: Guides
    type: folder
  items:
  - info:
      name: List Guide Pages
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/guides
      params:
      - name: branch
        value: ''
        type: path
    docs: List Guide Pages
  - info:
      name: Create A Guide Page
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches/:branch/guides
      params:
      - name: branch
        value: ''
        type: path
    docs: Create A Guide Page
  - info:
      name: Get A Guide By Slug
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/guides/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Get A Guide By Slug
  - info:
      name: Update A Guide
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch/guides/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Update A Guide
  - info:
      name: Delete A Guide
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch/guides/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Delete A Guide
- info:
    name: Changelog
    type: folder
  items:
  - info:
      name: List Changelog Posts
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/changelogs
      params:
      - name: branch
        value: ''
        type: path
    docs: List Changelog Posts
  - info:
      name: Create A Changelog Post
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches/:branch/changelogs
      params:
      - name: branch
        value: ''
        type: path
    docs: Create A Changelog Post
  - info:
      name: Get A Changelog Post
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/changelogs/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Get A Changelog Post
  - info:
      name: Update A Changelog Post
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch/changelogs/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Update A Changelog Post
  - info:
      name: Delete A Changelog Post
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch/changelogs/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Delete A Changelog Post
- info:
    name: Custom Pages
    type: folder
  items:
  - info:
      name: List Custom Pages
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/custom_pages
      params:
      - name: branch
        value: ''
        type: path
    docs: List Custom Pages
  - info:
      name: Create A Custom Page
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches/:branch/custom_pages
      params:
      - name: branch
        value: ''
        type: path
    docs: Create A Custom Page
  - info:
      name: Get A Custom Page
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/custom_pages/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Get A Custom Page
  - info:
      name: Update A Custom Page
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch/custom_pages/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Update A Custom Page
  - info:
      name: Delete A Custom Page
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch/custom_pages/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Delete A Custom Page
- info:
    name: Categories
    type: folder
  items:
  - info:
      name: List Categories
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/categories
      params:
      - name: branch
        value: ''
        type: path
    docs: List Categories
  - info:
      name: Create A Category
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches/:branch/categories
      params:
      - name: branch
        value: ''
        type: path
    docs: Create A Category
  - info:
      name: Get A Category
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch/categories/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Get A Category
  - info:
      name: Update A Category
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch/categories/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Update A Category
  - info:
      name: Delete A Category
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch/categories/:slug
      params:
      - name: branch
        value: ''
        type: path
      - name: slug
        value: ''
        type: path
    docs: Delete A Category
- info:
    name: Branches
    type: folder
  items:
  - info:
      name: List Branches
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches
    docs: List Branches
  - info:
      name: Create A Branch
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/branches
    docs: Create A Branch
  - info:
      name: Get A Branch
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/branches/:branch
      params:
      - name: branch
        value: ''
        type: path
    docs: Get A Branch
  - info:
      name: Update A Branch
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/branches/:branch
      params:
      - name: branch
        value: ''
        type: path
    docs: Update A Branch
  - info:
      name: Delete A Branch
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/branches/:branch
      params:
      - name: branch
        value: ''
        type: path
    docs: Delete A Branch
- info:
    name: Images
    type: folder
  items:
  - info:
      name: Upload An Image
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/images
    docs: Upload An Image
- info:
    name: Recipes
    type: folder
  items:
  - info:
      name: List Recipes
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/recipes
    docs: List Recipes
  - info:
      name: Create A Recipe
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/recipes
    docs: Create A Recipe
  - info:
      name: Get A Recipe
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/recipes/:slug
      params:
      - name: slug
        value: ''
        type: path
    docs: Get A Recipe
  - info:
      name: Update A Recipe
      type: http
    http:
      method: PUT
      url: https://api.readme.com/v2/recipes/:slug
      params:
      - name: slug
        value: ''
        type: path
    docs: Update A Recipe
  - info:
      name: Delete A Recipe
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/recipes/:slug
      params:
      - name: slug
        value: ''
        type: path
    docs: Delete A Recipe
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Search Knowledge Base
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/search
      params:
      - name: q
        value: ''
        type: query
    docs: Search Knowledge Base
- info:
    name: API Keys
    type: folder
  items:
  - info:
      name: List API Keys
      type: http
    http:
      method: GET
      url: https://api.readme.com/v2/apikeys
    docs: List API Keys
  - info:
      name: Create An API Key
      type: http
    http:
      method: POST
      url: https://api.readme.com/v2/apikeys
    docs: Create An API Key
  - info:
      name: Delete An API Key
      type: http
    http:
      method: DELETE
      url: https://api.readme.com/v2/apikeys/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete An API Key
bundled: true