ReadMe

List all API definitions (OpenAPI specs) in a branch. Returns filenames, types, and upload status.

Get an API definition by filename. Use list_api_definitions to find available filenames.

Delete an API definition permanently. Use list_api_definitions to find filenames.

List all branches (versions) in the ReadMe project. Returns branch names and metadata.

Create a new branch (version) in the ReadMe project. Requires a name (semver). Optionally fork from an existing versi…

Get details of a specific branch (version) by name or version number. Use list_branches to find available branches.

Update a branch’s title. Use list_branches to find available branch names.

Delete a branch (version) permanently. Cannot delete the stable branch. Use list_branches to find branch names.

List categories in a branch by section type (guides or reference). Use branch=‘stable’ for the default version.

Create a new category in a branch. Requires a title. Section defaults to ‘guide’. Use list_categories to see existing…

Get a specific category by section and title. Use list_categories to find available category titles.

Update a category’s title or position. Use list_categories to find category titles.

Delete a category permanently. Use list_categories to find category titles.

List all pages within a category. Use list_categories to find section and title values.

List changelog entries with pagination. Supports filtering by visibility. Use page and per_page for pagination.

Create a new changelog entry. Requires a title. Optionally set type (added, fixed, improved, etc.) and body content.

Get a changelog entry by slug or ID. Use list_changelogs to find available slugs.

Update a changelog entry’s title, type, body, or visibility. Use list_changelogs to find slugs.

Delete a changelog entry permanently. Use list_changelogs to find slugs.

List all custom pages in a branch. Custom pages are standalone pages outside the guides/reference sections.

Create a new custom page. Requires a title. Supports markdown or HTML content.

Get a custom page by slug. Use list_custom_pages to find available slugs.

Update a custom page’s title, content, or visibility. Use list_custom_pages to find slugs.

Delete a custom page permanently. Use list_custom_pages to find slugs.

Create a new guide page. Requires title and category_uri. Use list_categories with section=‘guides’ to find category …

Get a guide page by slug. Use list_category_pages to find guide slugs.

Update a guide page’s title, body, state, or visibility. Use list_category_pages to find guide slugs.

Delete a guide page permanently. Use list_category_pages to find guide slugs.

List uploaded images with pagination. Use page and per_page for pagination (max 100 per page).

Get an uploaded image by ID. Use list_images to find available image IDs.

Get ReadMe project metadata including name, subdomain, plan, and configuration. Useful for discovering project settings.

List all recipes (tutorials) in a branch. Recipes are step-by-step guides for common tasks.

Create a new recipe (tutorial). Requires a title. Optionally include body content and excerpt.

Get a recipe by slug. Use list_recipes to find available recipe slugs.

Update a recipe’s title, body, excerpt, or visibility. Use list_recipes to find slugs.

Delete a recipe permanently. Use list_recipes to find recipe slugs.

Create a new API reference page. Requires title and category_uri. Use list_categories with section=‘reference’ to fin…

Get an API reference page by slug. Use list_category_pages with section=‘reference’ to find page slugs.

Update an API reference page’s title, body, state, or visibility. Use list_category_pages to find page slugs.

Delete an API reference page permanently. Use list_category_pages to find page slugs.

Search across all documentation pages, guides, changelogs, and references. Returns matching results with highlighted …

Validate ReadMe credentials. Verifies that the API key is valid by fetching project metadata.