capabilities.work

What you can do with ReadMe

Every task in plain language. Pick one, and we can help you get access.

12 things you can do

ReadMe

ReadMe is a developer hub platform that helps companies design, document, and operate their APIs. The platform combines hosted API reference (OpenAPI-driven), guides and changelog, bi-directional Git sync (GitHub and GitLab), interactive API explorer, Try-It console, Developer Dashboard with real-time API logs, and a deep layer of AI tooling — including the ReadMe Agent for multi-page editing, Inl

12 multi-step recipes

Recipes: multi-step jobs

Create A Category With A Guide
Create a category then create a guide inside it and verify the guide.Cut A Version And Announce It
Create a branch, upload its API definition, and announce it in the changelog.Publish A Changelog Post
Create a changelog post then fetch it back by slug.Publish A Custom Page
Create a custom page then fetch it back by slug.Publish A Recipe
Create a recipe then fetch it back by slug.Stand Up A New Version With Starter Docs
Create a new branch, a category on it, and a starter guide in the category.Submit Metrics And Audit Quality
Submit API request logs then retrieve page quality scores.Upload An API Definition And Verify
Upload an API definition to a branch then fetch it back by id.Upsert A Category
Update a category if its slug exists on the branch, otherwise create it.Upsert A Changelog Post
Update a changelog post if its slug exists, otherwise create it.Upsert A Custom Page
Update a custom page if its slug exists on the branch, otherwise create it.Upsert A Guide Page
Update a guide if its slug already exists on the branch, otherwise create it.