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 14 APIs on the APIs.io network, including Personalized Docs Webhook, Analytics API, API Keys API, and 11 more. Tagged areas include Documentation, Developer Hub, API Reference, Portal, 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 40 more developer resources.

🌐 Visit website 📡 Source on GitHub

51.1/100 developing ▬ flat Agent 28/100 agent aware Front door AI 5/6 prominent saas Full breakdown ↓
scored 2026-09-25 · rubric v0.23.0

AccessFreemiumSelf serve⚡ Free to try

2 APIs

DocumentationDeveloper HubAPI Reference Portal Analytics Artificial Intelligence MCPBi-Directional SyncAPI Documentation Developer Portal OpenAPI

Kin Score

Kin Score How this is scored →
scored 2026-09-25 · rubric v0.23.0

Composite quality — 51.1/100 · developing

Contract Quality 11.3 / 19

Developer Ergonomics 7.9 / 15

Access Clarity 8.1 / 15

Operational Transparency 3.3 / 10

Contract Governance 2.5 / 9

Discoverability 5.0 / 8

Regulatory Posture 3.4 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 28/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/readme: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

ReadMe is an area vendor: providers adopt it to run part of their developer surface. This is the Kin Score checks its features can move for a provider that adopts it, what each one really earns, and what it earns nothing for.

documentationdeveloper portalmeasured17 features checked 2026-09-25 · rubric v0.22.0

ReadMe is the broadest developer-portal lift in this set: Try It!, a changelog with RSS, forums, Getting Started and Authentication landing pages, recipes, and a Discoverability panel (llms.txt, RFC 9727 api-catalog, agent-skills index, content signals) that is on every plan. Most of those are pointer checks, so they count only once the provider declares them in its apis.json. The hosted MCP server is the most capable docs MCP here (its execute-request tool calls the API), but it is one ReadMe template on readme.io or the hub domain, so the rubric grades it platform; and ReadMe renders the OpenAPI it is given, so Contract Quality does not move.

Agent Readiness31.0 of 139 pts

Contract Quality24.0 of 211 pts

Developer Ergonomics26.8 of 42 pts

Discoverability10.0 of 54 pts

Operational Transparency9.0 of 38 pts

Check	Earns	Through
Machine-Readable Contractsaturated Agent Readiness · customers 0.0 pts vs controlSame as contract_present — only when the designer’s OpenAPI is the provider’s first published contract.	18.0 of 18	API Designer
Well-Known Catalog Agent Readiness · customers +8.0 pts vs controlDeclare the api-catalog URL as an APICatalog / WellKnown pointer.	4.0 of 4	RFC 9727 api-catalog and Link headers
Consent & Bot Identity Agent Readiness · customers -0.6 pts vs controlSet the signals and declare them as a ContentSignal pointer; the dimension reads the pointer, not the robots output.	3.0 of 3	Content signals for AI use
MCP Serverplatform Agent Readiness · customers 0.0 pts vs controlOne ReadMe server template across every project; 0.22.0 grades that `platform` (0.25 of 12) even though its execute-request tool calls the provider’s API rather than only searching docs.	3.0 of 12	Hosted MCP server
Request/Response Examplespartial Agent Readiness · customers +11.7 pts vs controlThe dimension reads examples inside the OpenAPI first; recipes and generated code samples reach only the Examples / Code Samples link fallback.	1.8 of 7	Recipes
Agent Skillsdiscounted Agent Readiness · customers -4.0 pts vs controlThe page does not say who writes the advertised skills; absent evidence that they are provider-authored, a platform-published skill set is graded `derived`.	1.3 of 5	Agent Skills discovery index
Publishes a machine-readable contractsaturated Contract Quality · customers +1.3 pts vs controlOnly for a provider with no published contract that builds its reference in the API Designer and exposes the resulting OpenAPI (via the api-catalog or a download link).	20.0 of 20	API Designer
Change log Operational Transparency · customers -2.5 pts vs controlPost to it and declare it as a ChangeLog pointer.	6.0 of 6	Changelog with RSS
Serves a .well-known surface Discoverability · customers +4.0 pts vs controlTurn on API Catalog and serve the hub at the root of a host the harvest probes (docs.); an Enterprise hub under a path prefix is not at a host root.	6.0 of 6	RFC 9727 api-catalog and Link headers
Getting started guide Developer Ergonomics · customers -14.0 pts vs controlFill in the Getting Started page and declare it as a GettingStarted pointer.	5.0 of 5	Getting Started and Authentication landing pages
Authentication documentedsaturated Developer Ergonomics · customers -3.5 pts vs control94% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.	5.0 of 5	Getting Started and Authentication landing pages
Documentationsaturated Developer Ergonomics · customers -32.6 pts vs control95% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.	4.0 of 4	Hosted developer hub with guides and API reference
Developer portal Developer Ergonomics · customers -14.0 pts vs controlDeclare the hub as a DeveloperPortal pointer.	4.0 of 4	Hosted developer hub with guides and API reference
Published example corpus Contract Quality · customers -8.0 pts vs controlWrite recipes and declare the recipes index as a CodeExamples pointer.	4.0 of 4	Recipes
Publishes llms.txt Discoverability · customers +20.6 pts vs controlGenerated from the provider’s own docs on the provider’s domain, so it reads as the provider’s (rule 2’s own-content, own-domain case); a Git-authored custom llms.txt is plainly first-party.	4.0 of 4	Generated llms.txt (split by section or category)
API referencesaturated Developer Ergonomics · customers -33.8 pts vs control94% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.	3.0 of 3	Hosted developer hub with guides and API reference
Console or sandbox Developer Ergonomics · customers +10.0 pts vs controlDeclare Try It! (or the reference) as a Console pointer.	3.0 of 3	Try It! API explorer
Support channel Developer Ergonomics · customers +5.3 pts vs controlEnable the forum and declare it as a Community pointer.	2.0 of 2	Discussion forums and dev FAQ
Agent Skilldiscounted Developer Ergonomics · customers -4.0 pts vs controlSame artifact as agent_skills, same authorship discount.	0.8 of 3	Agent Skills discovery index
Webhooks advertisedconditional Operational Transparency · customers +26.4 pts vs controlOnly if the API already has webhooks; rendering the webhooks object cannot invent one.	3.0 of 3	OpenAPI 3.1 webhooks rendering

122 detected customers vs 5094 comparable providers: composite 48.1 vs 48.0, agent readiness 34.4 vs 32.5. Association, not cause.

Across 8977 providers that publish a contract, adopting ReadMe would move 8977. Median lift: composite +8.6 (90th percentile +13.5), agent readiness +8.1 (+9.4). Conditional rows excluded.

What ReadMe ships that earns nothing (4)

MCP server card and WebMCP tools — The MCP server card is not an api-catalog, security.txt, protected-resource or AAuth document; only the api-catalog row earns this check.
Health check banner — A banner that relays Statuspage.io is not a status page; the provider still needs its own StatusPage.
Postman collection sync — ReadMe consumes collections and offers a fork button; the collection itself must be one the provider publishes.
Hosted developer hub with guides and API reference — Rendering a spec’s examples writes none into the contract; contract-side examples are the provider’s own work.

A model, not a score. Adopting this vendor changes a provider's Kin Score only when the provider publishes the resulting artifacts on its own surface; nothing here writes a score, and no sponsorship or partnership can. The rating is not for sale → · Full vendor facets artifact

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

ReadMe APIs API

Manage API definitions and reference pages

Scroll for all 14

Open Collections 15

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

API Collection

OPEN COLLECTION

ReadMe Developer Metrics Analytics API

OPEN COLLECTION

ReadMe Developer Metrics Analytics API Keys API

OPEN COLLECTION

ReadMe Developer Metrics Analytics APIs API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Branches API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Categories API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Changelog API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Custom Pages API

OPEN COLLECTION

ReadMe Developer Metrics API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Guides API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Images API

OPEN COLLECTION

ReadMe Developer Analytics Metrics API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Recipes API

OPEN COLLECTION

ReadMe Developer Metrics Analytics Search API

OPEN COLLECTION

ReadMe API

OPEN COLLECTION

Scroll for all 15

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

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

Scroll for all 12

Pricing Plans 1

Published pricing tiers and plan structures.

Readme Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Readme Rate Limits

2 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Readme Finops

FINOPS

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

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Readme Context

35 classes · 0 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

ReadMe API Rules

3 rules · 1 errors 1 warnings 1 info

SPECTRAL

ReadMe API Rules

5 rules · 3 warnings 2 info

SPECTRAL

ReadMe API Rules

9 rules · 5 errors 4 warnings

SPECTRAL

JSON Schema 5

Standalone JSON Schema definitions for this provider's data models.

ReadMe API Definition

9 properties

JSON SCHEMA

ReadMe Branch

8 properties

JSON SCHEMA

ReadMe Changelog Post

8 properties

JSON SCHEMA

ReadMe Guide

11 properties

JSON SCHEMA

ReadMe Metrics Request Log

6 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Readme Developer Hub Structure

0 properties

JSON STRUCTURE

Examples 5

Example request and response payloads for these APIs.

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

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Readme Authentication

http · 2 schemes

SECURITY

Readme Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Readme Agentic Access

44 operations · 25 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

Portal

Portal

GettingStarted

GettingStarted

Signup

Signup

Login

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

LlmsText

LlmsText

Design & Contract 15

Pagination, idempotency, versioning, errors, and events

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Arazzo

Vocabulary

JSONLDContext

SpectralRules

Scroll for all 15

Build 8

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace

GitHubOrg

CLI

SDKs

Tools

Tools

Tools

GitHubAction

Scroll for all 8

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 3

Status, limits, changes, and where to get help

ChangeLog

ChangeLog

StatusPage

StatusPage

RateLimits

RateLimits

Commercial 5

Pricing, plans, and the legal terms of use

Pricing

TermsOfService

PrivacyPolicy

Plans

FinOps

Company 4

The organization behind the API

Website

Website

Blog

Blog

About

About

LinkedIn

Other 2

Properties that don't map to a standard resource type

VendorFacets

VendorFacets

Marketplace

Marketplace

Source (apis.yml)

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.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-09-03'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/readme.png
type: Index
access: 3rd-Party
position: Consuming
created: '2025-01-08'
modified: '2026-05-30'
x-docs-platform: readme
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-09-17
tags:
- Documentation
- Developer Hub
- API Reference
- Portal
- Analytics
- Artificial Intelligence
- MCP
- Bi-Directional Sync
- API Documentation
- Developer Portal
- OpenAPI
tags_raw:
- Documentation
- Developer Hub
- API Reference
- Portals
- Analytics
- AI
- MCP
- Bi-Directional Sync
- API Documentation
- Developer Portal
- OpenAPI
segments:
- Documentation
apis:
- 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
  - Artificial Intelligence
  - Agents
  tags_raw:
  - 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:
  - Webhook
  - Personalized Docs
  - Developer Hub
  - Authentication
  tags_raw:
  - 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: SDKs
    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
- aid: readme:readme-analytics-api
  name: ReadMe Analytics API
  description: Page view, quality, and search analytics
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Analytics
  properties:
  - type: OpenAPI
    url: openapi/readme-analytics-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-api-keys-api
  name: ReadMe API Keys API
  description: Manage ReadMe API keys
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - APIKeys
  tags_raw:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/readme-api-keys-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-branches-api
  name: ReadMe Branches API
  description: Manage versions and branches
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Branches
  properties:
  - type: OpenAPI
    url: openapi/readme-branches-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-categories-api
  name: ReadMe Categories API
  description: Manage sidebar groupings
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Categories
  properties:
  - type: OpenAPI
    url: openapi/readme-categories-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-changelog-api
  name: ReadMe Changelog API
  description: Manage changelog posts
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Changelog
  properties:
  - type: OpenAPI
    url: openapi/readme-changelog-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-custom-pages-api
  name: ReadMe Custom Pages API
  description: Manage custom documentation pages
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Custom Pages
  properties:
  - type: OpenAPI
    url: openapi/readme-custom-pages-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-guides-api
  name: ReadMe Guides API
  description: Manage knowledge base guide pages
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Guides
  properties:
  - type: OpenAPI
    url: openapi/readme-guides-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-images-api
  name: ReadMe Images API
  description: Upload and manage images
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Image
  tags_raw:
  - Images
  properties:
  - type: OpenAPI
    url: openapi/readme-images-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-metrics-api
  name: ReadMe Metrics API
  description: Send API request metrics from server-side SDKs
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Metrics
  properties:
  - type: OpenAPI
    url: openapi/readme-metrics-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-recipes-api
  name: ReadMe Recipes API
  description: Manage interactive recipe content
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Recipes
  properties:
  - type: OpenAPI
    url: openapi/readme-recipes-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-search-api
  name: ReadMe Search API
  description: Search knowledge base content
  humanURL: https://docs.readme.com/main/reference/intro-to-the-readme-api
  baseURL: https://api.readme.com/v2
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/readme-search-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
- aid: readme:readme-apis-api
  name: ReadMe APIs API
  description: Manage API definitions and reference pages
  humanURL: https://docs.readme.com/main/docs/readmes-mcp-server
  baseURL: https://api.readme.com/v2
  tags: []
  tags_raw:
  - APIs
  properties:
  - type: OpenAPI
    url: openapi/readme-apis-api-openapi.yml
  - 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: Documentation
    url: https://docs.readme.com/main/docs/sending-api-logs
  - type: SDKs
    url: https://github.com/readmeio/metrics-sdks
common:
- type: VendorFacets
  url: vendor-facets/readme-vendor-facets.yml
- type: Website
  url: https://www.readme.com/
- type: AgenticAccess
  url: agentic-access/readme-agentic-access.yml
- type: DomainSecurity
  url: security/readme-domain-security.yml
- type: Authentication
  url: authentication/readme-authentication.yml
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/readme/overview
- type: Arazzo
  url: arazzo/readme-create-branch-with-guide-workflow.yml
  name: ReadMe Stand Up A New Version With Starter Docs
- type: Arazzo
  url: arazzo/readme-create-category-with-guide-workflow.yml
  name: ReadMe Create A Category With A Guide
- type: Arazzo
  url: arazzo/readme-publish-changelog-post-workflow.yml
  name: ReadMe Publish A Changelog Post
- type: Arazzo
  url: arazzo/readme-publish-custom-page-workflow.yml
  name: ReadMe Publish A Custom Page
- type: Arazzo
  url: arazzo/readme-publish-recipe-workflow.yml
  name: ReadMe Publish A Recipe
- type: Arazzo
  url: arazzo/readme-release-version-workflow.yml
  name: ReadMe Cut A Version And Announce It
- type: Arazzo
  url: arazzo/readme-submit-metrics-and-audit-workflow.yml
  name: ReadMe Submit Metrics And Audit Quality
- type: Arazzo
  url: arazzo/readme-upload-api-definition-workflow.yml
  name: ReadMe Upload An API Definition And Verify
- type: Arazzo
  url: arazzo/readme-upsert-category-workflow.yml
  name: ReadMe Upsert A Category
- type: Arazzo
  url: arazzo/readme-upsert-changelog-post-workflow.yml
  name: ReadMe Upsert A Changelog Post
- type: Arazzo
  url: arazzo/readme-upsert-custom-page-workflow.yml
  name: ReadMe Upsert A Custom Page
- type: Arazzo
  url: arazzo/readme-upsert-guide-workflow.yml
  name: ReadMe Upsert A Guide Page
- 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: LlmsText
  url: https://docs.readme.com/llms.txt
- type: CLI
  url: https://github.com/readmeio/rdme
- type: SDKs
  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.23'

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/readme"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/readme/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/readme/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

ReadMe

What adopting ReadMe moves on the Kin Score 20

APIs 14

Open Collections 15

Arazzo Workflows 12

Pricing Plans 1

Rate Limits 1

FinOps 1

Event Specifications 1

Semantic Vocabularies 1

Spectral Rules 3

JSON Schema 5

JSON Structure 1

Examples 5

Security Posture 2

Agentic Access 1

Get Started 4

Documentation 2

Agent Surfaces 2

Design & Contract 15

Build 8

Access & Security 2

Operate 3

Commercial 5

Company 4

Other 2

Source (apis.yml)

MCP server

Tools for providers

Call it yourself

Get an API key