Connect ReadMe with Open Flow
Keep a guide accurate and give each release a clear set of notes.
20,000 free app calls per month (paid services billed separately)
What you can do
Find and revise documentation, inspect versions and categories, and maintain changelogs for the connected project.
Documentation
Search, read, create, and revise documentation pages.
Project Structure
Read versions, categories, project metadata, and OpenAPI definitions.
Release Notes
Read, create, and revise changelogs.
All actions
Get Project
Get metadata for the ReadMe project associated with the API key.
readme.get_projectList Versions
List the versions configured for the ReadMe project.
readme.list_versionsGet Version
Get one ReadMe project version by semver identifier.
readme.get_versionCreate Version
Create a new ReadMe project version from an existing base version.
readme.create_versionUpdate Version
Update one ReadMe project version by semver identifier.
readme.update_versionDelete Version
Delete one ReadMe project version by semver identifier.
readme.delete_versionList Categories
List ReadMe guide and reference categories with optional version and pagination.
readme.list_categoriesCreate Category
Create a ReadMe guide or reference category.
readme.create_categoryGet Category
Get one ReadMe category by slug.
readme.get_categoryUpdate Category
Update one ReadMe category by slug.
readme.update_categoryDelete Category
Delete one ReadMe category by slug.
readme.delete_categoryList Category Docs
List the ReadMe docs that belong to a category slug.
readme.list_category_docsSearch Docs
Search ReadMe docs by text query.
readme.search_docsCreate Doc
Create a ReadMe doc page using a category ID or category slug.
readme.create_docGet Doc
Get one ReadMe doc by slug, optionally requesting the production doc version.
readme.get_docUpdate Doc
Update one ReadMe doc page by slug.
readme.update_docDelete Doc
Delete one ReadMe doc page by slug.
readme.delete_docList Custom Pages
List ReadMe custom pages with optional pagination.
readme.list_custom_pagesCreate Custom Page
Create a ReadMe custom page.
readme.create_custom_pageGet Custom Page
Get one ReadMe custom page by slug.
readme.get_custom_pageUpdate Custom Page
Update one ReadMe custom page by slug.
readme.update_custom_pageDelete Custom Page
Delete one ReadMe custom page by slug.
readme.delete_custom_pageList Changelogs
List ReadMe changelog entries with optional pagination.
readme.list_changelogsCreate Changelog
Create a ReadMe changelog entry.
readme.create_changelogGet Changelog
Get one ReadMe changelog entry by slug.
readme.get_changelogUpdate Changelog
Update one ReadMe changelog entry by slug.
readme.update_changelogDelete Changelog
Delete one ReadMe changelog entry by slug.
readme.delete_changelogList Api Specifications
List ReadMe API specification metadata with optional version and pagination.
readme.list_api_specificationsDelete Api Specification
Delete one ReadMe API specification by ID.
readme.delete_api_specificationGet Api Registry
Retrieve one ReadMe API Registry entry by UUID.
readme.get_api_registryGet Openapi Schema
Get the OpenAPI definition for the ReadMe project.
readme.get_openapi_schemaList Outbound Ips
List ReadMe outbound IP addresses used for webhook and Try It proxy requests.
readme.list_outbound_ipsAsk Owlbot
Ask ReadMe Owlbot a non-streaming question and return its answer with sources.
readme.ask_owlbotNo actions match your search.
Connect ReadMe with Open Flow
20,000 free app calls per month (paid services billed separately)