GitHub README fetched & rendered to text API

Fetches a repo's default README and renders the Markdown down to clean plain text (code fences, images, HTML, emphasis and table markup stripped), plus extracts the heading outline, a link count, and a word count, with bounded truncation. Answers 'what does owner/repo do, in plain text', 'give me the README outline', 'summarize this project's README for an agent'.

Price$0.01per request

MethodPOST

Route/v1/dev/github-readme

StatusLive

MIME typeapplication/json

Rate limit60/minute

Cache43200s public

devgithubreadmedocumentationmarkdowntextrenderoutline

API URLhttps://x402.hexl.dev/v1/dev/github-readme

Integration docs

Example request

{
  "repo": "expressjs/express",
  "maxChars": 600
}

Example response

{
  "repo": "expressjs/express",
  "file": "Readme.md",
  "sizeBytes": 10165,
  "headings": [
    "Table of contents",
    "Installation",
    "Features",
    "Docs & Community",
    "Quick Start",
    "Philosophy"
  ],
  "linkCount": 95,
  "wordCount": 705,
  "truncated": true,
  "text": "Fast, unopinionated, minimalist web framework for Node.js.\n\nThis project has a [Code of Conduct].\n\n# Table of contents\n\nTable of contents\nInstallation\nFeatures\nDocs \\& Community\nQuick Start\nPhilosophy\nExamples\nContributing\n - Security Issues\n - Running Tests\nCurrent project team members\n - TC (Techn ..."
}

Input schema

{
  "type": "object",
  "required": [
    "repo"
  ],
  "properties": {
    "repo": {
      "type": "string",
      "description": "'owner/name' or github.com URL."
    },
    "maxChars": {
      "type": "integer",
      "minimum": 200,
      "maximum": 40000,
      "default": 8000,
      "description": "Max characters of rendered text to return."
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}