ReadMe API

REST discovered

Details

URL: https://api.readme.com/v2
Docs: https://docs.readme.com/main/reference

Authentication

ReadMe project API key bearer discovered Get token ↗

Authorization: Bearer <credential>

In your ReadMe project, create an API key from the API Reference area documented at Create an API key. The authentication guide at Authentication describes using this key with the ReadMe API. For CLI automation, the rdme docs and support thread indicate you can supply the same project API key to the CLI with --key alongside your project --id.