ReadMe

aid: readme
url: https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/apis.yml
name: ReadMe
description: >-
  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.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
type: Index
access: 3rd-Party
position: Consumer
created: '2025-01-08'
modified: '2026-05-30'
tags:
- Documentation
- Developer Hub
- API Reference
- Portals
- Analytics
- AI
- MCP
- Bi-Directional Sync
segments:
- Documentation
apis:
- aid: readme:readme-api
  name: ReadMe API
  description: >-
    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.
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Documentation
  - Developer Hub
  - Content Management
  - API Reference
  properties:
  - type: Documentation
    url: https://docs.readme.com/main/reference/intro-to-the-readme-api
  - type: Authentication
    url: https://docs.readme.com/main/reference/authentication
  - type: OpenAPI
    url: https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/openapi/readme-openapi.yml
  - url: graphql/readme-graphql.md
    type: GraphQL
- aid: readme:developer-metrics-api
  name: ReadMe Developer Metrics API
  description: >-
    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 page quality scores, page view statistics, and
    search analytics so teams can investigate API usage by key or email and debug requests in real time.
  humanURL: https://docs.readme.com/main/docs/sending-api-logs
  baseURL: https://metrics.readme.io/v1
  tags:
  - Analytics
  - Metrics
  - Logging
  - Developer Dashboard
  properties:
  - type: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: OpenAPI
    url: >-
      https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/openapi/readme-developer-metrics-openapi.yml
  - type: SDK
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:mcp-server
  name: ReadMe MCP Server
  description: >-
    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 natural language. ReadMe also auto-provisions a
    per-project MCP server for every customer so end users' AI tools can read, search, and call that project's API
    directly.
  humanURL: https://docs.readme.com/main/docs/readmes-mcp-server
  tags:
  - MCP
  - AI
  - Model Context Protocol
  - Agents
  properties:
  - type: Documentation
    url: https://docs.readme.com/main/docs/readmes-mcp-server
  - type: UseCases
    url: https://docs.readme.com/main/docs/readmes-mcp-use-cases
  - type: Documentation
    url: https://docs.readme.com/main/docs/your-projects-mcp-server
  - type: UseCases
    url: https://docs.readme.com/main/docs/your-projects-mcp-use-cases
  - type: Explainer
    url: https://docs.readme.com/main/docs/mcp-servers
- aid: readme:personalized-docs-webhook
  name: ReadMe Personalized Docs Webhook
  description: >-
    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 containing the user's email, signs the
    request with a Stripe-style `ReadMe-Signature` header (`t=<unix-ms>,v0=<hmac-sha256-hex>`) using the project's
    webhook secret, and expects a JSON response describing the user (apiKey, keys array, server-variable parameters,
    Basic Auth, GraphQL bearer, etc.) which the hub then merges into the rendered API Reference, Try-It console, and
    Recipes. The single documented event is the user-data lookup.
  humanURL: https://docs.readme.com/main/docs/personalized-docs-webhook
  tags:
  - Webhooks
  - Personalized Docs
  - Developer Hub
  - Authentication
  properties:
  - type: Documentation
    url: https://docs.readme.com/main/docs/personalized-docs-webhook
  - type: Explainer
    url: https://docs.readme.com/main/docs/personalized-docs
  - type: Documentation
    url: https://docs.readme.com/main/docs/user-data-options
  - type: SDK
    url: https://github.com/readmeio/metrics-sdks
  - type: AsyncAPI
    url: >-
      https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/asyncapi/readme-personalized-docs-webhook-asyncapi.yml
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/readme/overview
- type: ArazzoWorkflows
  url: arazzo/
  workflows:
  - url: arazzo/readme-create-branch-with-guide-workflow.yml
    name: ReadMe Stand Up A New Version With Starter Docs
    summary: Create a branch (version), add a category, and seed it with a first guide.
  - url: arazzo/readme-create-category-with-guide-workflow.yml
    name: ReadMe Create A Category With A Guide
    summary: Create a sidebar category and immediately add a guide page to it.
  - url: arazzo/readme-publish-changelog-post-workflow.yml
    name: ReadMe Publish A Changelog Post
    summary: Create a changelog post on a branch and read it back by slug.
  - url: arazzo/readme-publish-custom-page-workflow.yml
    name: ReadMe Publish A Custom Page
    summary: Create a custom page on a branch and read it back by slug.
  - url: arazzo/readme-publish-recipe-workflow.yml
    name: ReadMe Publish A Recipe
    summary: Create an interactive recipe and read it back by slug.
  - url: arazzo/readme-release-version-workflow.yml
    name: ReadMe Cut A Version And Announce It
    summary: Create a branch, upload its API definition, and post a launch changelog.
  - url: arazzo/readme-submit-metrics-and-audit-workflow.yml
    name: ReadMe Submit Metrics And Audit Quality
    summary: Send API request logs to Metrics, then retrieve page quality scores.
  - url: arazzo/readme-upload-api-definition-workflow.yml
    name: ReadMe Upload An API Definition And Verify
    summary: Upload an OpenAPI definition to a branch and read the created definition back.
  - url: arazzo/readme-upsert-category-workflow.yml
    name: ReadMe Upsert A Category
    summary: Find a category by slug and update it if it exists, otherwise create it.
  - url: arazzo/readme-upsert-changelog-post-workflow.yml
    name: ReadMe Upsert A Changelog Post
    summary: Find a changelog post by slug and update it if it exists, otherwise create it.
  - url: arazzo/readme-upsert-custom-page-workflow.yml
    name: ReadMe Upsert A Custom Page
    summary: Find a custom page by slug and update it if it exists, otherwise create it.
  - url: arazzo/readme-upsert-guide-workflow.yml
    name: ReadMe Upsert A Guide Page
    summary: Find a guide by slug and update it if it exists, otherwise create it.
- type: Portal
  url: https://readme.com
- type: GettingStarted
  url: https://docs.readme.com/main/docs/quickstart
- type: Documentation
  url: https://docs.readme.com
- type: APIReference
  url: https://docs.readme.com/main/reference/intro-to-the-readme-api
- type: Pricing
  url: https://readme.com/pricing
- type: SignUp
  url: https://dash.readme.com/signup
- type: Login
  url: https://dash.readme.com/login
- type: Blog
  url: https://readme.com/blog
- type: ChangeLog
  url: https://docs.readme.com/main/changelog
- type: About
  url: https://readme.com/about
- type: StatusPage
  url: https://www.readmestatus.com
- type: TermsOfService
  url: https://readme.com/tos
- type: PrivacyPolicy
  url: https://readme.com/privacy
- type: GitHubOrg
  url: https://github.com/readmeio
- type: LinkedIn
  url: https://www.linkedin.com/company/readme
- type: LLMsTxt
  url: https://docs.readme.com/llms.txt
- type: CLI
  url: https://github.com/readmeio/rdme
- type: SDK
  url: https://github.com/readmeio/metrics-sdks
- type: Tools
  url: https://github.com/readmeio/oas
- type: Tools
  url: https://github.com/readmeio/api
- type: Tools
  url: https://github.com/readmeio/markdown
- type: GitHubAction
  url: https://github.com/readmeio/rdme
- type: Marketplace
  url: https://github.com/readmeio/marketplace
- type: Plans
  url: plans/readme-plans-pricing.yml
- type: RateLimits
  url: rate-limits/readme-rate-limits.yml
- type: FinOps
  url: finops/readme-finops.yml
- type: Vocabulary
  url: vocabulary/readme-vocabulary.yml
- type: JSONLDContext
  url: json-ld/readme-context.jsonld
- type: SpectralRules
  url: rules/readme-rules.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
specificationVersion: '0.19'