GitHub
GitHub Repo README API
A repository's README as decoded markdown, ready to chunk for RAG or feed to a model. Costs 1 credit per request.
POST/api/v1/github/repo/readme
Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is your Scavio API key (e.g. Bearer sk_live_your_key).
Body
application/jsonurlstringrequiredA github.com/<owner>/<repo> URL or a bare <owner>/<repo>.
Example: facebook/react
Request
from scavio import ScavioClient
client = ScavioClient(api_key="sk_live_your_key")
result = client.github.repo_readme("facebook/react")
print(result)Response
"markdown": "# [React](https://react.dev/) · [](https://github.com/facebook/react/blob/main/LICENSE) [](https://www.npmjs.com/package/react) [![(Runtime)...",
"html_url": "https://github.com/react/react/blob/main/README.md",
"name": "README.md",
"size": 5317
},
"response_time": 2785
}