Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ReadMe Categories API

Manage sidebar groupings

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

Tagged areas include Categories. 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.1.0, at version 1.0.

Requests are made against a single base URL, https://metrics.readme.io/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.1.0
API Version
1.0
Base URL
https://api.readme.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

ReadMe Categories API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth using your ReadMe API key as the username (password blank).

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.

Categories 5

Manage sidebar groupings

GET
/branches/{branch}/categories
List Categories
1 param → 200
POST
/branches/{branch}/categories
Create A Category
1 param → 201
GET
/branches/{branch}/categories/{slug}
Get A Category
2 params → 200
PUT
/branches/{branch}/categories/{slug}
Update A Category
2 params → 200
DELETE
/branches/{branch}/categories/{slug}
Delete A Category
2 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

readme-categories-api-openapi.yml Raw ↑

Other APIs ReadMe publishes across the network.

ReadMe MCP Server
ReadMe Personalized Docs Webhook
ReadMe Analytics API
ReadMe API Keys API
ReadMe APIs API
ReadMe Branches API
ReadMe Changelog API
ReadMe Custom Pages API
ReadMe Guides API
ReadMe Images API
ReadMe Metrics API
ReadMe Recipes API