ReadMe

ReadMe integration (Developer Tools, Productivity). Imported from open-connector.

API key33 toolshttps://dash.readme.com/api/v1

GET

readme_get_project

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

GET

readme_list_versions

List the versions configured for the ReadMe project.

/version

GET

readme_get_version

Get one ReadMe project version by semver identifier.

/version/{input}

2 parameters

Param	Type	Required	Description
versionId	string	optional	The semver identifier for the project version, preferably the version_clean val…
input	string	required	Path parameter: input

POST

readme_create_version

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

/version

8 parameters

Param	Type	Required	Description
version	string	required	The semantic version identifier for the ReadMe project version.
codename	string	optional	The codename for the ReadMe project version.
from	string	required	The semantic version to use as the base fork.
is_stable	boolean	optional	Whether this version should be the main stable version.
is_beta	boolean	optional	Whether this version is beta.
is_hidden	boolean	optional	Whether this version is hidden.
is_deprecated	boolean	optional	Whether this version is deprecated.
pdfStatus	string	optional	The PDF generation status for the version.

PUT

readme_update_version

Update one ReadMe project version by semver identifier.

/version/{input}

10 parameters

Param	Type	Required	Description
versionId	string	required	The semver identifier for the ReadMe project version to update.
version	string	optional	The semantic version identifier for the ReadMe project version.
codename	string	optional	The codename for the ReadMe project version.
from	string	optional	The semantic version to use as the base fork.
is_stable	boolean	optional	Whether this version should be the main stable version.
is_beta	boolean	optional	Whether this version is beta.
is_hidden	boolean	optional	Whether this version is hidden.
is_deprecated	boolean	optional	Whether this version is deprecated.
pdfStatus	string	optional	The PDF generation status for the version.
input	string	required	Path parameter: input

DELETE

readme_delete_version

Delete one ReadMe project version by semver identifier.

/version/{input}

2 parameters

Param	Type	Required	Description
versionId	string	optional	The semver identifier for the project version, preferably the version_clean val…
input	string	required	Path parameter: input

GET

readme_list_categories

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

/categories

3 parameters

Param	Type	Required	Description
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
perPage	integer	optional	The number of items to include per page. ReadMe accepts values up to 100.
page	integer	optional	The one-based page number to request.

POST

readme_create_category

Create a ReadMe guide or reference category.

/categories

3 parameters

Param	Type	Required	Description
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
title	string	required	A short title for the category.
type	string	optional	The ReadMe category type.

GET

readme_get_category

Get one ReadMe category by slug.

/categories/{input}

3 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe slug to request.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
input	string	required	Path parameter: input

PUT

readme_update_category

Update one ReadMe category by slug.

/categories/{input}

5 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe category slug to update.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
title	string	optional	A short title for the category.
type	string	optional	The ReadMe category type.
input	string	required	Path parameter: input

DELETE

readme_delete_category

Delete one ReadMe category by slug.

/categories/{input}

3 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe slug to request.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
input	string	required	Path parameter: input

GET

readme_list_category_docs

List the ReadMe docs that belong to a category slug.

/categories/{input}/docs

3 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe slug to request.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
input	string	required	Path parameter: input

POST

readme_search_docs

Search ReadMe docs by text query.

/docs/search

2 parameters

Param	Type	Required	Description
search	string	required	The search text to look for in ReadMe docs.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…

POST

readme_create_doc

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

/docs

11 parameters

Param	Type	Required	Description
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
title	string	optional	The title of the ReadMe doc.
type	string	optional	The ReadMe doc page type.
body	string	optional	The ReadMe-flavored Markdown body content for the page.
category	string	optional	The ReadMe category ID for the page.
categorySlug	string	optional	The ReadMe category slug for the page.
hidden	boolean	optional	Whether the doc is hidden.
order	integer	optional	The position of the doc in the project sidebar.
parentDoc	string	optional	The parent doc ID if the page is a subpage.
parentDocSlug	string	optional	The parent doc slug if the page is a subpage.
error	object	optional	Deprecated error-page metadata for ReadMe docs.

GET

readme_get_doc

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

/docs/{slug}

3 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe doc slug to request.
production	boolean	optional	Whether to request the production version of the doc.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…

PUT

readme_update_doc

Update one ReadMe doc page by slug.

/docs/{input}

13 parameters

Param	Type	Required	Description
slug	string	optional	The URL-safe ReadMe doc slug to update.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
title	string	optional	The title of the ReadMe doc.
type	string	optional	The ReadMe doc page type.
body	string	optional	The ReadMe-flavored Markdown body content for the page.
category	string	optional	The ReadMe category ID for the page.
categorySlug	string	optional	The ReadMe category slug for the page.
hidden	boolean	optional	Whether the doc is hidden.
order	integer	optional	The position of the doc in the project sidebar.
parentDoc	string	optional	The parent doc ID if the page is a subpage.
parentDocSlug	string	optional	The parent doc slug if the page is a subpage.
error	object	optional	Deprecated error-page metadata for ReadMe docs.
input	string	required	Path parameter: input

DELETE

readme_delete_doc

Delete one ReadMe doc page by slug.

/docs/{input}

3 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe slug to request.
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
input	string	required	Path parameter: input

GET

readme_list_custom_pages

List ReadMe custom pages with optional pagination.

/custompages

2 parameters

Param	Type	Required	Description
perPage	integer	optional	The number of items to include per page. ReadMe accepts values up to 100.
page	integer	optional	The one-based page number to request.

POST

readme_create_custom_page

Create a ReadMe custom page.

/custompages

5 parameters

Param	Type	Required	Description
title	string	required	The title of the ReadMe custom page.
body	string	optional	The Markdown body content for the custom page.
html	string	optional	The HTML body content for the custom page.
htmlmode	boolean	optional	Whether ReadMe should display html instead of body.
hidden	boolean	optional	Whether the custom page is hidden.

GET

readme_get_custom_page

Get one ReadMe custom page by slug.

/custompages/{input}

2 parameters

Param	Type	Required	Description
slug	string	optional	The URL-safe ReadMe custom page slug to request.
input	string	required	Path parameter: input

PUT

readme_update_custom_page

Update one ReadMe custom page by slug.

/custompages/{input}

7 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe custom page slug to update.
title	string	optional	The title of the ReadMe custom page.
body	string	optional	The Markdown body content for the custom page.
html	string	optional	The HTML body content for the custom page.
htmlmode	boolean	optional	Whether ReadMe should display html instead of body.
hidden	boolean	optional	Whether the custom page is hidden.
input	string	required	Path parameter: input

DELETE

readme_delete_custom_page

Delete one ReadMe custom page by slug.

/custompages/{input}

2 parameters

Param	Type	Required	Description
slug	string	optional	The URL-safe ReadMe custom page slug to delete.
input	string	required	Path parameter: input

GET

readme_list_changelogs

List ReadMe changelog entries with optional pagination.

/changelogs

2 parameters

Param	Type	Required	Description
perPage	integer	optional	The number of items to include per page. ReadMe accepts values up to 100.
page	integer	optional	The one-based page number to request.

POST

readme_create_changelog

Create a ReadMe changelog entry.

/changelogs

4 parameters

Param	Type	Required	Description
title	string	required	The title of the ReadMe changelog entry.
type	string	optional	The ReadMe changelog entry type.
body	string	required	The body content of the ReadMe changelog entry.
hidden	boolean	optional	Whether the changelog entry is hidden.

GET

readme_get_changelog

Get one ReadMe changelog entry by slug.

/changelogs/{input}

2 parameters

Param	Type	Required	Description
slug	string	optional	The URL-safe ReadMe changelog slug to request.
input	string	required	Path parameter: input

PUT

readme_update_changelog

Update one ReadMe changelog entry by slug.

/changelogs/{input}

6 parameters

Param	Type	Required	Description
slug	string	required	The URL-safe ReadMe changelog slug to update.
title	string	optional	The title of the ReadMe changelog entry.
type	string	optional	The ReadMe changelog entry type.
body	string	optional	The body content of the ReadMe changelog entry.
hidden	boolean	optional	Whether the changelog entry is hidden.
input	string	required	Path parameter: input

DELETE

readme_delete_changelog

Delete one ReadMe changelog entry by slug.

/changelogs/{input}

2 parameters

Param	Type	Required	Description
slug	string	optional	The URL-safe ReadMe changelog slug to delete.
input	string	required	Path parameter: input

GET

readme_list_api_specifications

List ReadMe API specification metadata with optional version and pagination.

/api-specification

3 parameters

Param	Type	Required	Description
version	string	optional	The optional ReadMe project version to send with the x-readme-version header, f…
perPage	integer	optional	The number of items to include per page. ReadMe accepts values up to 100.
page	integer	optional	The one-based page number to request.

DELETE

readme_delete_api_specification

Delete one ReadMe API specification by ID.

/api-specification/{input}

2 parameters

Param	Type	Required	Description
id	string	optional	The API specification ID to delete.
input	string	required	Path parameter: input

GET

readme_get_api_registry

Retrieve one ReadMe API Registry entry by UUID.

/api-registry/{input}

2 parameters

Param	Type	Required	Description
uuid	string	optional	The API Registry UUID to retrieve from ReadMe.
input	string	required	Path parameter: input

GET

readme_get_openapi_schema

Get the OpenAPI definition for the ReadMe project.

/schema

GET

readme_list_outbound_ips

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

/outbound-ips

POST

readme_ask_owlbot

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

/owlbot/ask

1 parameter

Param	Type	Required	Description
question	string	optional	The question to ask Owlbot.