ReadMe

ReadMe APIs API

Manage API definitions and reference pages

Documentation GitHub OpenAPI

Operations 5

GET /branches/{branch}/apis List API Definitions

POST /branches/{branch}/apis Upload An API Definition

GET /branches/{branch}/apis/{id} Get An API Definition

PUT /branches/{branch}/apis/{id} Update An API Definition

DELETE /branches/{branch}/apis/{id} Delete An API Definition

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

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

All apis

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

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.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ReadMe AP Is 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.
  version: '2.0'
  contact:
    name: ReadMe Support
    url: https://docs.readme.com
  license:
    name: Proprietary
    url: https://readme.com/tos
servers:
- url: https://api.readme.com/v2
  description: ReadMe API v2 base URL
- url: https://dash.readme.io/api/v1
  description: ReadMe API v1 (legacy)
security:
- bearerAuth: []
tags:
- name: APIs
  description: Manage API definitions and reference pages
paths:
  /branches/{branch}/apis:
    get:
      tags:
      - APIs
      summary: List API Definitions
      description: Retrieve metadata for API definitions on a branch.
      parameters:
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: perPage
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 10
      - name: page
        in: query
        schema:
          type: integer
          minimum: 1
          default: 1
      responses:
        '200':
          description: Successful retrieval
        '401':
          description: Unauthorized
        '404':
          description: Branch not found
    post:
      tags:
      - APIs
      summary: Upload An API Definition
      responses:
        '201':
          description: Created
  /branches/{branch}/apis/{id}:
    get:
      tags:
      - APIs
      summary: Get An API Definition
      parameters:
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: API definition
    put:
      tags:
      - APIs
      summary: Update An API Definition
      parameters:
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated
    delete:
      tags:
      - APIs
      summary: Delete An API Definition
      parameters:
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use your ReadMe API key as a Bearer token in the Authorization header.