# Connect ReadMe with Open Flow

Source: https://openflow.run/en/integrations/readme/

[All integrations](https://openflow.run/en/integrations/)

Keep a guide accurate and give each release a clear set of notes.

*   [33 actions](https://openflow.run/en/integrations/readme/#integration-actions)
*   API key
*   Developer tools
*   Productivity

[Connect ReadMe](https://console.openflow.run/connections/readme)

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

33 actions

### Get Project

Get metadata for the ReadMe project associated with the API key.

`readme.get_project`

### List Versions

List the versions configured for the ReadMe project.

`readme.list_versions`

### Get Version

Get one ReadMe project version by semver identifier.

`readme.get_version`

### Create Version

Create a new ReadMe project version from an existing base version.

`readme.create_version`

### Update Version

Update one ReadMe project version by semver identifier.

`readme.update_version`

### Delete Version

Delete one ReadMe project version by semver identifier.

`readme.delete_version`

### List Categories

List ReadMe guide and reference categories with optional version and pagination.

`readme.list_categories`

### Create Category

Create a ReadMe guide or reference category.

`readme.create_category`

### Get Category

Get one ReadMe category by slug.

`readme.get_category`

### Update Category

Update one ReadMe category by slug.

`readme.update_category`

### Delete Category

Delete one ReadMe category by slug.

`readme.delete_category`

### List Category Docs

List the ReadMe docs that belong to a category slug.

`readme.list_category_docs`

### Search Docs

Search ReadMe docs by text query.

`readme.search_docs`

### Create Doc

Create a ReadMe doc page using a category ID or category slug.

`readme.create_doc`

### Get Doc

Get one ReadMe doc by slug, optionally requesting the production doc version.

`readme.get_doc`

### Update Doc

Update one ReadMe doc page by slug.

`readme.update_doc`

### Delete Doc

Delete one ReadMe doc page by slug.

`readme.delete_doc`

### List Custom Pages

List ReadMe custom pages with optional pagination.

`readme.list_custom_pages`

### Create Custom Page

Create a ReadMe custom page.

`readme.create_custom_page`

### Get Custom Page

Get one ReadMe custom page by slug.

`readme.get_custom_page`

### Update Custom Page

Update one ReadMe custom page by slug.

`readme.update_custom_page`

### Delete Custom Page

Delete one ReadMe custom page by slug.

`readme.delete_custom_page`

### List Changelogs

List ReadMe changelog entries with optional pagination.

`readme.list_changelogs`

### Create Changelog

Create a ReadMe changelog entry.

`readme.create_changelog`

### Get Changelog

Get one ReadMe changelog entry by slug.

`readme.get_changelog`

### Update Changelog

Update one ReadMe changelog entry by slug.

`readme.update_changelog`

### Delete Changelog

Delete one ReadMe changelog entry by slug.

`readme.delete_changelog`

### List Api Specifications

List ReadMe API specification metadata with optional version and pagination.

`readme.list_api_specifications`

### Delete Api Specification

Delete one ReadMe API specification by ID.

`readme.delete_api_specification`

### Get Api Registry

Retrieve one ReadMe API Registry entry by UUID.

`readme.get_api_registry`

### Get Openapi Schema

Get the OpenAPI definition for the ReadMe project.

`readme.get_openapi_schema`

### List Outbound Ips

List ReadMe outbound IP addresses used for webhook and Try It proxy requests.

`readme.list_outbound_ips`

### Ask Owlbot

Ask ReadMe Owlbot a non-streaming question and return its answer with sources.

`readme.ask_owlbot`

No actions match your search.

## Connect ReadMe with Open Flow

[Connect ReadMe](https://console.openflow.run/connections/readme)

20,000 free app calls per month (paid services billed separately)
