ReadMe

Get Project

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

List Versions

List the versions configured for the ReadMe project.

Get Version

Get one ReadMe project version by semver identifier.

Create Version

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

Update Version

Update one ReadMe project version by semver identifier.

Delete Version

Delete one ReadMe project version by semver identifier.

List Categories

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

Create Category

Create a ReadMe guide or reference category.

Get Category

Get one ReadMe category by slug.

Update Category

Update one ReadMe category by slug.

Delete Category

Delete one ReadMe category by slug.

List Category Docs

List the ReadMe docs that belong to a category slug.

Search Docs

Search ReadMe docs by text query.

Create Doc

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

Get Doc

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

Update Doc

Update one ReadMe doc page by slug.

Delete Doc

Delete one ReadMe doc page by slug.

List Custom Pages

List ReadMe custom pages with optional pagination.

Create Custom Page

Create a ReadMe custom page.

Get Custom Page

Get one ReadMe custom page by slug.

Update Custom Page

Update one ReadMe custom page by slug.

Delete Custom Page

Delete one ReadMe custom page by slug.

List Changelogs

List ReadMe changelog entries with optional pagination.

Create Changelog

Create a ReadMe changelog entry.

Get Changelog

Get one ReadMe changelog entry by slug.

Update Changelog

Update one ReadMe changelog entry by slug.

Delete Changelog

Delete one ReadMe changelog entry by slug.

List Api Specifications

List ReadMe API specification metadata with optional version and pagination.

Delete Api Specification

Delete one ReadMe API specification by ID.

Get Api Registry

Retrieve one ReadMe API Registry entry by UUID.

Get Openapi Schema

Get the OpenAPI definition for the ReadMe project.

List Outbound Ips

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

Ask Owlbot

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