# ReadMe Documentation ## Guides - [Creating a Project](https://docs.readme.com/main/docs/creating-a-project.md) - [Project Settings](https://docs.readme.com/main/docs/project-settings.md) - [Quick Switcher](https://docs.readme.com/main/docs/quick-switcher.md): The fastest way to navigate ReadMe - [Your Dashboard and Profile](https://docs.readme.com/main/docs/your-dashboard-and-profile.md) - [Custom Login Page](https://docs.readme.com/main/docs/custom-login-page.md) - [ReadMe's Outbound IP Addresses](https://docs.readme.com/main/docs/ip-addresses.md) - [Navigating Your Hub](https://docs.readme.com/main/docs/navigating-your-hub-1.md) - [Quick Nav in the API Reference](https://docs.readme.com/main/docs/quick-nav-api-reference.md) - [Search + Search API](https://docs.readme.com/main/docs/search.md) - [OpenAPI Support in ReadMe](https://docs.readme.com/main/docs/openapi.md) - [Categories, Pages, and Subpages](https://docs.readme.com/main/docs/openapi-categories-pages-subpages.md) - [OpenAPI Compatibility Chart](https://docs.readme.com/main/docs/openapi-compatibility-chart.md) - [OpenAPI Extensions](https://docs.readme.com/main/docs/openapi-extensions.md): We've added a few OpenAPI extensions to help you better integrate with ReadMe. - [Re-syncing Your OpenAPI Document](https://docs.readme.com/main/docs/openapi-resyncing.md) - [Other Ways to Send API Requests](https://docs.readme.com/main/docs/other-ways-to-use-api-metrics.md) - [Project Setup: Your Hub, Your Way](https://docs.readme.com/main/docs/project-setup.md) - [Allow iFrames](https://docs.readme.com/main/docs/allowing-iframes.md) - [Having Problems Generating SSL?](https://docs.readme.com/main/docs/having-problems-generating-ssl.md) - [Setting Custom Domain & SSL](https://docs.readme.com/main/docs/setting-up-custom-domain.md) - [Turn Off Cloudflare Proxy](https://docs.readme.com/main/docs/turn-off-cloudflare-proxy.md): For customers that use Cloudflare - [URL Paths in ReadMe](https://docs.readme.com/main/docs/url-paths-in-readme.md) - [Error Pages](https://docs.readme.com/main/docs/error-pages.md): Choose what endusers see when they encounter a 404 in your project - [System Configuration](https://docs.readme.com/main/docs/system-configuration.md) - [Internal Documentation](https://docs.readme.com/main/docs/internal-documentation.md): Control who can access your docs - [Login Expiration](https://docs.readme.com/main/docs/login-expiration.md) - [Redirect Scenarios](https://docs.readme.com/main/docs/redirect-scenarios.md): Learn how and when visitors to your project are redirected to other pages - [Suggested Edits](https://docs.readme.com/main/docs/suggested-edits.md) - [Sending Data to Your Documentation's Users](https://docs.readme.com/main/docs/user-data-options.md) - [Feature Requests](https://docs.readme.com/main/docs/feature-requests.md): Help us shape the future of ReadMe! - [Need More Support?](https://docs.readme.com/main/docs/need-more-support.md) - [Bug Bounty Program](https://docs.readme.com/main/docs/bug-bounty-program.md) - [Security FAQ](https://docs.readme.com/main/docs/security-faq.md) - [Technical FAQ](https://docs.readme.com/main/docs/technical-faq.md) - [Accessibility Conformance Report](https://docs.readme.com/main/docs/vpat.md) - [Customizing Docs Using CSS Variables](https://docs.readme.com/main/docs/customizing-docs-using-css-variables.md) - [Custom CSS and JavaScript](https://docs.readme.com/main/docs/custom-css-and-javascript.md) - [Dark Mode: Overview & Custom CSS](https://docs.readme.com/main/docs/custom-css-with-dark-mode.md) - [Custom Icons](https://docs.readme.com/main/docs/custom-icons.md) - [Design Themes](https://docs.readme.com/main/docs/design-themes.md) - [Amazon API Gateway](https://docs.readme.com/main/docs/aws.md) - [Google Analytics](https://docs.readme.com/main/docs/google-analytics.md) - [Google Site Verification](https://docs.readme.com/main/docs/google-site-verification.md) - [Integrations](https://docs.readme.com/main/docs/integrations.md) - [Localize](https://docs.readme.com/main/docs/localize.md) - [reCaptcha](https://docs.readme.com/main/docs/recaptcha.md) - [Segment](https://docs.readme.com/main/docs/segment.md) - [Slack](https://docs.readme.com/main/docs/slack.md): Get updates on your docs directly within Slack! - [Stainless](https://docs.readme.com/main/docs/stainless.md): Automatically update your API reference when publishing an SDK with Stainless - [Transifex](https://docs.readme.com/main/docs/transifex.md) - [Typekit](https://docs.readme.com/main/docs/typekit-key.md) - [Zendesk](https://docs.readme.com/main/docs/zendesk.md) - [Making Your Hub Shine](https://docs.readme.com/main/docs/making-your-hub-shine.md) - [Pro Tips](https://docs.readme.com/main/docs/pro-tips.md) - [Site Navigation](https://docs.readme.com/main/docs/site-navigation.md) - [Site Footer](https://docs.readme.com/main/docs/site-footer.md) - [Subheader Layout](https://docs.readme.com/main/docs/subheader-layout.md) - [Ask AI Dropdown](https://docs.readme.com/main/docs/AskAI.md): Learn about leveraging powerful AI assistants that help users find answers, generate code, and understand complex concepts without ever leaving your docs. - [LLMs.txt](https://docs.readme.com/main/docs/LLMstxt.md): Control how AI language models interpret your API documentation - [Owlbot AI](https://docs.readme.com/main/docs/owlbot.md): Powered by OpenAI, Owlbot AI answers your users’ questions in a snap πŸ¦‰ - [API Exploration Tools](https://docs.readme.com/main/docs/api-exploration-tools.md) - [API Reference](https://docs.readme.com/main/docs/reference-core-pages.md) - [My Requests Overview](https://docs.readme.com/main/docs/my-requests.md): Let your users see their recently made API requests and debug issues right from your docs - [SDKs](https://docs.readme.com/main/docs/sdks.md): This section explains the prerequisites to consider when setting up a ReadMe SDK for the first time. - [.NET Setup](https://docs.readme.com/main/docs/net-setup.md) - [Python (Django) Setup](https://docs.readme.com/main/docs/python-django-api-metrics.md) - [Python (Flask) Setup](https://docs.readme.com/main/docs/python-flask-api-metrics.md) - [Ruby (Rails/Rack) Setup](https://docs.readme.com/main/docs/ruby-api-metrics-set-up.md) - [Node.js Setup](https://docs.readme.com/main/docs/sending-logs-to-readme-with-nodejs.md) - [PHP (Laravel) Setup](https://docs.readme.com/main/docs/sending-logs-to-readme-with-php-laravel.md) - [Show API Request History To Users](https://docs.readme.com/main/docs/showing-api-logs-to-users.md) - [Real-Time API Logs Overview](https://docs.readme.com/main/docs/sending-api-logs.md) - [Creating a Dev FAQ](https://docs.readme.com/main/docs/creating-a-dev-faq.md) - [Discussion Forums](https://docs.readme.com/main/docs/discussion-forums.md) - [Managing Forum Support](https://docs.readme.com/main/docs/managing-forum-support.md) - [Health Check Status Updates](https://docs.readme.com/main/docs/health-check-status-updates.md): Communicate real-time status to your users - [Community Building](https://docs.readme.com/main/docs/community-building.md) - [Supporting Your Developers](https://docs.readme.com/main/docs/supporting-your-developers.md) - [Developer Dashboard Overview](https://docs.readme.com/main/docs/developer-dashboard.md): Combine personalized, real-time API logs with API documentation. Plus surface your developers’ API keys right in your hub ✨ - [My Developers Overview](https://docs.readme.com/main/docs/my-developers.md): In-depth developer profiles where your team can dig into API usage and quickly debug issues πŸ”Ž - [Using Amazon API Gateway with the Personalized Docs Webhook](https://docs.readme.com/main/docs/amazon-api-gateway-webhook.md) - [Personalized API Docs Overview](https://docs.readme.com/main/docs/personalized-docs.md): Inject your users' API keys, server variables, and more! - [Set Up Personalized Docs](https://docs.readme.com/main/docs/personalized-docs-webhook.md): By telling ReadMe about the currently logged in user, the docs can show them their real API key, request history, and more! - [Export Metrics Data](https://docs.readme.com/main/docs/exporting-metrics-data.md) - [API & Docs Metrics Charts](https://docs.readme.com/main/docs/using-metrics-charts.md): Dig into the details of how your developers are using your API and docs with Metrics charts πŸ•΅ - [Building APIs from Scratch with the API Designer](https://docs.readme.com/main/docs/building-apis-from-scratch-with-the-api-designer.md) - [GraphQL API Reference (Limited Support)](https://docs.readme.com/main/docs/graphql.md): Try our GraphQL API Reference! - [API Reference](https://docs.readme.com/main/docs/api-reference.md): Learn how to use your API Reference to transform your API into a clear and accessible solution for developers. - [OpenAPI Upload and Management](https://docs.readme.com/main/docs/openapi-upload-and-management.md): Learn how to upload and manage your OAS files. - [Editing with Bi-Directional Sync](https://docs.readme.com/main/docs/editing-with-bi-directional-sync.md): Learn how to manage content, handle conflicts, and maintain consistency across platforms. - [Bi-Directional Sync](https://docs.readme.com/main/docs/bi-directional-sync.md) - [Changelog](https://docs.readme.com/main/docs/changelog.md): Keep a running record of your latest updates - [Custom Pages](https://docs.readme.com/main/docs/custom-page.md) - [Getting Started with Documentation](https://docs.readme.com/main/docs/document-api-overview.md) - [Creating and Managing Guides](https://docs.readme.com/main/docs/creating-and-managing-guides.md) - [Creating Mermaid Diagrams](https://docs.readme.com/main/docs/creating-mermaid-diagrams.md) - [Guides](https://docs.readme.com/main/docs/guides.md) - [Structuring Your Documentation](https://docs.readme.com/main/docs/structuring-your-docs.md) - [Landing Page](https://docs.readme.com/main/docs/landing-page.md) - [Building Custom MDX Components](https://docs.readme.com/main/docs/building-custom-mdx-components.md) - [MDX (Markdown + JSX)](https://docs.readme.com/main/docs/mdx.md) - [Rendering Errors: Invalid MDX](https://docs.readme.com/main/docs/rendering-errors-invalid-mdx.md) - [Using MDX](https://docs.readme.com/main/docs/using-mdx.md): Learn how to enhance your documentation with MDX by understanding its syntax, patterns, and best practices. - [ReadMe’s New UI](https://docs.readme.com/main/docs/new-editor-ui.md): As a part of [ReadMe Refactored](https://readme.com/future), we introduced a redesigned ReadMe. - [πŸ” ReadMe Micro Overview](https://docs.readme.com/main/docs/readme-micro.md): Keep track of your team’s internal APIs and microservices with ReadMe’s auto-generated documentation solution. - [Creating a Recipe](https://docs.readme.com/main/docs/creating-recipes.md) - [Recipes](https://docs.readme.com/main/docs/recipes.md): Step-by-step code walkthroughs for your most popular API use cases - [Reusable Content](https://docs.readme.com/main/docs/reusable-content.md): Create reusable blocks of Markdown content to use repeatedly across your project’s Guides and API reference pages! - [Versioning](https://docs.readme.com/main/docs/versions.md) - [Manage Team](https://docs.readme.com/main/docs/manage-team.md): Control who can access and admin your project backend - [Payment and Billing Info](https://docs.readme.com/main/docs/payment-and-billing-info.md): β€œI saw a bank that said ’24-Hour Banking,’ but I didn’t have that much time.” - [Plans and Pricing](https://docs.readme.com/main/docs/plans-and-pricing.md): We offer a variety of plans to suit your needs, whether you’re just getting started or looking for enterprise-grade solutions. - [Transfer Ownership](https://docs.readme.com/main/docs/transfer-ownership.md): Set another team member as the owner of a project - [Two-Factor Authentication](https://docs.readme.com/main/docs/two-factor-authentication.md) - [Your Account](https://docs.readme.com/main/docs/your-account.md): We're happy you're here! - [GitHub Actions Example: Syncing Markdown](https://docs.readme.com/main/docs/github-actions-docs-example.md) - [GitHub Actions Example: Syncing OpenAPI](https://docs.readme.com/main/docs/github-actions-openapi-example.md) - [Syncing Docs via CLI / GitHub](https://docs.readme.com/main/docs/rdme.md): Update your docs automatically with `rdme`, ReadMe's official CLI and GitHub Action! - [πŸ‘‹ Welcome to ReadMe!](https://docs.readme.com/main/docs/about-readme.md) - [πŸ“¦ Moving Your Docs to Their New Home](https://docs.readme.com/main/docs/migration-moving-your-docs-to-their-new-home.md) - [πŸš€ Quickstart Guide](https://docs.readme.com/main/docs/quickstart.md) - [Migration FAQ](https://docs.readme.com/main/docs/migration-faq.md) - [ReadMe Refactored: Overview and Migration Guide](https://docs.readme.com/main/docs/migration.md) - [Upgrading your ReadMe CLI to rdme@10](https://docs.readme.com/main/docs/upgrading-to-rdme10.md) ## API Reference - [Send an API Log to ReadMe](https://docs.readme.com/main/reference/post_request.md): Send an API Log to ReadMe, so that you can view developer usage metrics about your API. For more information see https://docs.readme.com/main/docs/sending-api-logs. - [Metrics API Introduction](https://docs.readme.com/main/reference/metrics-api-introduction.md): See how people use your docs and how developers use your API - [Get average page quality](https://docs.readme.com/main/reference/getaveragepagequality.md): Get the total number of project page quality votes, broken down into positive and overall votes. - [Get best pages](https://docs.readme.com/main/reference/getbestpages.md): Get the pages in your docs project with the highest number of positive votes. - [Get page comments](https://docs.readme.com/main/reference/getpagecomments.md): Get a list of comments associated with page votes within a time period. - [Get page breakdown](https://docs.readme.com/main/reference/getpageperformance.md): Get votes and comments for a particular project page. - [Get worst pages](https://docs.readme.com/main/reference/getworstpages.md): Get the pages in your docs project with the highest number of negative votes. - [Get difference in page views](https://docs.readme.com/main/reference/gethistoricalpageviews.md): Get percent difference period-over-period of unique and total views for a project. - [Get page views per day](https://docs.readme.com/main/reference/getpageviewsbyday.md): Get count of page views per day for a particular date range. - [Get users](https://docs.readme.com/main/reference/getpageviewsbyuser.md): Get unique user email addresses with the most views for a project, sorted by total views per user. - [Get views by path](https://docs.readme.com/main/reference/getpageviewsforpath.md): For a given page, see which viewers and how many times they visited, ordered by count. - [Get top pages](https://docs.readme.com/main/reference/gettoppages.md): Retrieve top pages associated with a project and their respective counts. - [Get total page views](https://docs.readme.com/main/reference/gettotalpageviews.md): Get total page views for a project. - [Get unique page views](https://docs.readme.com/main/reference/getuniquepageviews.md): Gets total unique page views for a project. - [Get top search terms](https://docs.readme.com/main/reference/gettopsearchterms.md): Retrieve top terms searched for in your project, and associated counts. - [Get data by search term](https://docs.readme.com/main/reference/getusersbysearchterm.md): Retrieve a breakdown of users who have searched for a particular term, include email and count. - [API v1 β†’ v2 Migration Guide](https://docs.readme.com/main/reference/api-migration-guide.md) - [Retrieve an entry from the API Registry](https://docs.readme.com/main/reference/getapiregistry.md): Get an API definition file that's been uploaded to ReadMe. - [Delete specification](https://docs.readme.com/main/reference/deleteapispecification.md): Delete an API specification in ReadMe. - [Get our OpenAPI Definition](https://docs.readme.com/main/reference/getapischema.md): Returns a copy of our OpenAPI Definition. - [Get metadata](https://docs.readme.com/main/reference/getapispecification.md): Get API specification metadata. - [Update specification](https://docs.readme.com/main/reference/updateapispecification.md): Update an API specification in ReadMe. - [Upload specification](https://docs.readme.com/main/reference/uploadapispecification.md): Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/main/docs/rdme. - [Validate API specification](https://docs.readme.com/main/reference/validateapispecification.md): Validate an API specification. - [Submit your application!](https://docs.readme.com/main/reference/applytoreadme.md): This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI! - [Get open roles](https://docs.readme.com/main/reference/getopenroles.md): Returns all the roles we're hiring for at ReadMe! - [Create category](https://docs.readme.com/main/reference/createcategory.md): Create a new category inside of this project. - [Delete category](https://docs.readme.com/main/reference/deletecategory.md): Delete the category with this slug. - [Get all categories](https://docs.readme.com/main/reference/getcategories.md): Returns all the categories for a specified version. - [Get category](https://docs.readme.com/main/reference/getcategory.md): Returns the category with this slug. - [Get docs for category](https://docs.readme.com/main/reference/getcategorydocs.md): Returns the docs and children docs within this category. - [Update category](https://docs.readme.com/main/reference/updatecategory.md): Change the properties of a category. - [Create changelog](https://docs.readme.com/main/reference/createchangelog.md): Create a new changelog entry. - [Delete changelog](https://docs.readme.com/main/reference/deletechangelog.md): Delete the changelog with this slug. - [Get changelog](https://docs.readme.com/main/reference/getchangelog.md): Returns the changelog with this slug. - [Get changelogs](https://docs.readme.com/main/reference/getchangelogs.md): Returns a list of changelogs. - [Update changelog](https://docs.readme.com/main/reference/updatechangelog.md): Update a changelog with this slug. - [Create custom page](https://docs.readme.com/main/reference/createcustompage.md): Create a new custom page inside of this project. - [Delete custom page](https://docs.readme.com/main/reference/deletecustompage.md): Delete the custom page with this slug. - [Get custom page](https://docs.readme.com/main/reference/getcustompage.md): Returns the custom page with this slug. - [Get custom pages](https://docs.readme.com/main/reference/getcustompages.md): Returns a list of custom pages. - [Update custom page](https://docs.readme.com/main/reference/updatecustompage.md): Update a custom page with this slug. - [Create doc](https://docs.readme.com/main/reference/createdoc.md): Create a new doc inside of this project. - [Delete doc](https://docs.readme.com/main/reference/deletedoc.md): Delete the doc with this slug. - [Get doc](https://docs.readme.com/main/reference/getdoc.md): Returns the doc with this slug. - [Get production doc](https://docs.readme.com/main/reference/getproductiondoc.md): This is intended for use by enterprise users with staging enabled. This endpoint will return the live version of your document, whereas the standard endpoint will always return staging. - [Search docs](https://docs.readme.com/main/reference/searchdocs.md): Returns all docs that match the search. - [Update doc](https://docs.readme.com/main/reference/updatedoc.md): Update a doc with this slug. - [Intro to the ReadMe API](https://docs.readme.com/main/reference/intro-to-the-readme-api.md): Control your docs programmatically with the ReadMe API - [Get ReadMe’s outbound IP addresses](https://docs.readme.com/main/reference/getoutboundips.md): Returns all of ReadMe’s IP addresses used for outbound webhook requests and the β€œTry It!” button on the API Explorer. Although ReadMe’s outbound IP addresses may change, the IPs in this API response will be valid for at least 7 days. If you configure your API or webhooks to limit access based on these IPs, you should refresh the IP list from this endpoint weekly. - [Ask Owlbot AI a question](https://docs.readme.com/main/reference/askowlbot.md): Ask Owlbot a question about the content of your docs. - [Limiting API Results](https://docs.readme.com/main/reference/pagination.md) - [Get metadata about the current project](https://docs.readme.com/main/reference/getproject.md): Returns project data for the API key. - [Create version](https://docs.readme.com/main/reference/createversion.md): Create a new version. - [Delete version](https://docs.readme.com/main/reference/deleteversion.md): Delete a version - [Get version](https://docs.readme.com/main/reference/getversion.md): Returns the version with this version ID. - [Get versions](https://docs.readme.com/main/reference/getversions.md): Retrieve a list of versions associated with a project API key. - [Update version](https://docs.readme.com/main/reference/updateversion.md): Update an existing version. - [Create an API key](https://docs.readme.com/main/reference/createapikey.md): Create an API key for your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete an API key](https://docs.readme.com/main/reference/deleteapikey.md): Delete an API key from your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get an API key](https://docs.readme.com/main/reference/getapikey.md): Get an API key for your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get your API keys](https://docs.readme.com/main/reference/getapikeys.md): Get the API keys for your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update an API key](https://docs.readme.com/main/reference/updateapikey.md): Update an API key on your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create a reference page](https://docs.readme.com/main/reference/createreference.md): Create a page in the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete a reference page](https://docs.readme.com/main/reference/deletereference.md): Delete a page from the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get a reference page](https://docs.readme.com/main/reference/getreference.md): Get a page from the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update a reference page](https://docs.readme.com/main/reference/updatereference.md): Updates an existing page in the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create an API definition](https://docs.readme.com/main/reference/createapi.md): Create an API definition in the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete an API definition](https://docs.readme.com/main/reference/deleteapi.md): Delete an API definition from the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get an API definition](https://docs.readme.com/main/reference/getapi.md): Get an API definition from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get all API definitions](https://docs.readme.com/main/reference/getapis.md): Get all API definitions from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update an API definition](https://docs.readme.com/main/reference/updateapi.md): Updates an API definition in the API Reference section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Validate an API](https://docs.readme.com/main/reference/validateapi.md): Validates an API definition for uploading to your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Submit your application!](https://docs.readme.com/main/reference/applytoreadme-1.md): This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI! >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get open roles](https://docs.readme.com/main/reference/getopenroles-1.md): Returns all the roles we're hiring for at ReadMe! >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create a category](https://docs.readme.com/main/reference/createcategory-1.md): Create a category in your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete a category](https://docs.readme.com/main/reference/deletecategory-1.md): Delete a category from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update a category](https://docs.readme.com/main/reference/updatecategory-1.md): Update an existing category in your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create a changelog entry](https://docs.readme.com/main/reference/createchangelog-1.md): Create a new changelog entry in your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete a changelog entry](https://docs.readme.com/main/reference/deletechangelog-1.md): Delete a changelog entry from your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get a changelog entry](https://docs.readme.com/main/reference/getchangelog-1.md): Get a changelog entry from your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get all changelog entries](https://docs.readme.com/main/reference/getchangelogs-1.md): Get all changelog entries from your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update a changelog entry](https://docs.readme.com/main/reference/updatechangelog-1.md): Update an existing changelog entry in your ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create a custom page](https://docs.readme.com/main/reference/createcustompage-1.md): Create a custom page in your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete a custom page](https://docs.readme.com/main/reference/deletecustompage-1.md): Delete a custom page from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get a custom page](https://docs.readme.com/main/reference/getcustompage-1.md): Get a custom page from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get all custom pages](https://docs.readme.com/main/reference/getcustompages-1.md): Get all custom pages from your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update a custom page](https://docs.readme.com/main/reference/updatecustompage-1.md): Update an existing custom page in your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Create a guides page](https://docs.readme.com/main/reference/createguide.md): Create a page in the Guides section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Delete a guides page](https://docs.readme.com/main/reference/deleteguide.md): Delete a page from the Guides section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get a guides page](https://docs.readme.com/main/reference/getguide.md): Get a page from the Guides section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Update a guides page](https://docs.readme.com/main/reference/updateguide.md): Updates an existing page in the Guides section of your ReadMe project. >πŸ“˜ > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored). >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get ReadMe's outbound IP addresses](https://docs.readme.com/main/reference/getoutboundips-1.md): Get all of ReadMe's IP addresses used for outbound webhook requests and the "Try It!" button on the API Explorer. Although ReadMe's outbound IP addresses may change, the IPs in this API response will be valid for at least 7 days. If you configure your API or webhooks to limit access based on these IPs, you should refresh the IP list from this endpoint weekly. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Get project metadata](https://docs.readme.com/main/reference/getproject-1.md): Returns data about your project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Perform a search query](https://docs.readme.com/main/reference/search-3.md): Searches the ReadMe project. >🚧 ReadMe's API v2 is currently in beta. >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback! - [Authentication](https://docs.readme.com/main/reference/authentication.md): Set up the welcome page for your API to help users make their first call. - [Getting Started](https://docs.readme.com/main/reference/getting-started.md): Set up the welcome page for your API to help users make their first call. - [My Requests](https://docs.readme.com/main/reference/my-requests.md): Set up the welcome page for your API to help users make their first call. ## Recipes - [Create a Custom Component](https://docs.readme.com/main/recipes/create-a-custom-component.md) - [Developer Dashboard Node/Express Configuration](https://docs.readme.com/main/recipes/developer-dashboard-nodeexpress-configuration.md) - [Sync Directory of Files via Code](https://docs.readme.com/main/recipes/sync-directory-of-files-via-code.md) - [Sync OAS files via Bitbucket Pipelines](https://docs.readme.com/main/recipes/sync-oas-files-via-bitbucket-pipelines.md) - [Sync OAS files via GitHub Actions](https://docs.readme.com/main/recipes/sync-oas-files-via-github-actions.md) - [Verify Webhook Signature](https://docs.readme.com/main/recipes/verify-webhook-signature.md) ## Pages - [404](https://docs.readme.com/main/404.md) - [What's a Custom Page?](https://docs.readme.com/main/custom-page.md) - [Welcome to Our New Editing UI](https://docs.readme.com/main/welcome-to-our-new-editor-ui.md) - [What is ReadMe Sync?](https://docs.readme.com/main/what-is-readme-sync.md) ## Changelog - [Ask AI for API References](https://docs.readme.com/main/changelog/ask-ai-for-api-references.md) - [Ask AI & llms.txt](https://docs.readme.com/main/changelog/ask-ai-llms-txt.md) - [Bug Fixes & Improvements](https://docs.readme.com/main/changelog/bug-fixes-improvements-4.md) - [Syncing Versions from GitHub](https://docs.readme.com/main/changelog/syncing-versions-from-github.md) - [Build and Use Custom Components With MDX](https://docs.readme.com/main/changelog/build-and-use-custom-components-with-mdx.md)