Skip to Content

ReadMe

Connect ReadMe to Cendriix to manage API documentation and guides.

Authentication

ReadMe uses API key authentication. You’ll need to generate an API key from your ReadMe dashboard.

Setup

  1. Navigate to Settings → Integrations → Connectors
  2. Find ReadMe in the connector list
  3. Click Connect
  4. Enter your API key when prompted
  5. The connector will be activated immediately

Admin Setup (Self-Hosted)

To enable ReadMe for your Cendriix instance:

  1. Generate an API key from your ReadMe dashboard 
  2. Note the API key for the next step
  3. Populate the Secrets Manager secret cendriix/prod/connectors/readme with:
    { "api_key": "..." }

Use Cases

  • Manage API documentation and guides
  • Automate workflows between ReadMe and your other connected tools
  • Query ReadMe data from Cendra AI assistant

Documentation

Last updated on