The ReadMe Copilot extension lets you questions about the ReadMe API and get help with code, directly in VS code!

You can ask about what OAS extensions ReadMe supports, how to do things with our API, about how to do various things in the product, and more!

Do you use ReadMe for your docs and want this for your developers? Contact [email protected] and we can get you set up!

Use-cases & example prompts to get started

• “@readme-api How do I apply to ReadMe via the API?”
• “@readme-api How do I apply to ReadMe via the API in python?”
• “@readme-api How do I get a list of pages in a category?”
• “@readme-api How do I see ReadMe’s outbound IP addresses?”
• “@readme-api What x-extensions does ReadMe support in OAS?”
• “@readme-api How does billing work?”
• “@readme-api How can I customize my docs?”
• “@readme-api How do I upload my OAS file?”
• “@readme-api How do I write reusable content?”