Public README Import API

Import any GitHub repository's README directly into the RedmiCodeGen Builder using a simple public API. This guide explains how to use the API, test it, and integrate it into your own tools or workflows.

How to Use

Generate API URL:
Replace the GitHub URL and token in this format:
Open in Builder:
Add the token to your builder URL:

Tip: The token can be any unique string. It links the imported README to your builder session. The API is public—no authentication required.

Examples

React Project:(In the app, clicking "Use" fills this as the repo URL and sets token to react-example.)
Vue.js Project:(In the app, clicking "Use" fills this as the repo URL and sets token to vue-example.)
Next.js Project:(In the app, clicking "Use" fills this as the repo URL and sets token to nextjs-example.)

Test the API

You can test the API with your own repository. In the app, you would enter your GitHub repository URL and a unique token, then click Test API to see the response, or Open in Builder to load the imported README in the builder. Here’s how it works:

GitHub Repository URL:
Token (any unique string):
Generated API URL:

API Response Example:

(In the app, the API response is shown below the test button.)

Open in Builder: After importing, you can open the builder with your token:

(In the app, clicking "Open in Builder" opens this URL in a new tab.)

Integration Guide

JavaScript/Node.js

cURL

Features

✅ Public Access: No authentication required
✅ Automatic Parsing: Converts README to editable sections
✅ One-time Use: Tokens are automatically cleaned up
✅ Rate Limited: Respects GitHub API limits
✅ Error Handling: Clear error messages for common issues
✅ Secure: Validates GitHub URLs and handles errors gracefully