How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ReadMe

ReadMe Custom Pages API

Manage custom documentation pages

Documentation Provider Profile APIs.io OpenAPI GitHub

ReadMe Custom Pages API is one of 14 APIs that ReadMe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: https://api.readme.com/v2, https://dash.readme.io/api/v1.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.readme.com/v2
Authentication
HTTP Bearer
Contact
ReadMe Support
License
Proprietary
Resource Areas
1

Authentication & Security 1

ReadMe Custom Pages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Use your ReadMe API key as a Bearer token in the Authorization header.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Pages 5

Manage custom documentation pages

GET
/branches/{branch}/custom_pages
List Custom Pages
getBranchesByBranchCustomPages 1 param → 200
POST
/branches/{branch}/custom_pages
Create A Custom Page
postBranchesByBranchCustomPages 1 param → 201
GET
/branches/{branch}/custom_pages/{slug}
Get A Custom Page
getBranchesByBranchCustomPagesBySlug 2 params → 200
PUT
/branches/{branch}/custom_pages/{slug}
Update A Custom Page
putBranchesByBranchCustomPagesBySlug 2 params → 200
DELETE
/branches/{branch}/custom_pages/{slug}
Delete A Custom Page
deleteBranchesByBranchCustomPagesBySlug 2 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

readme-custom-pages-api-openapi.yml Raw ↑

Other APIs ReadMe publishes across the network.

ReadMe MCP Server
AE Profile APIs.io
ReadMe Personalized Docs Webhook
AE Profile APIs.io
ReadMe Analytics API
AE Profile APIs.io
ReadMe API Keys API
AE Profile APIs.io
ReadMe Branches API
AE Profile APIs.io
ReadMe Categories API
AE Profile APIs.io
ReadMe Changelog API
AE Profile APIs.io
ReadMe Guides API
AE Profile APIs.io
ReadMe Images API
AE Profile APIs.io
ReadMe Metrics API
AE Profile APIs.io
ReadMe Recipes API
AE Profile APIs.io
ReadMe Search API
AE Profile APIs.io
#Custom Pages
← Back to R APIs
API Details
ID
readme:readme-custom-pages-api
Base URL
https://api.readme.com/v2
Docs
https://docs.readme.com/main/reference/intro-to-the-readme-api
Provider
ReadMe
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=readme-custom-pages-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/readme-custom-pages-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of ReadMe Custom Pages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.