urlstringrequired
GitHub repository URL, e.g. https://github.com/openai/whisper. The README of the default branch is returned.
GitHub Repository README
https://api.sandbase.ai/v1/api/github/repository-readmeGet a GitHub repository's README by repository URL, as the Markdown text the maintainers wrote, with its file name, path and size. Use it to learn what a project does, which models and tools it uses, and how to reach its authors.
- Price
- From $0.0012USD / call
- Method
- POST
- Response
- JSON
- Parameters
- 1 required · 1 optional
Playground
Input
GitHub repository URL, e.g. https://github.com/openai/whisper. The README of the default branch is returned.
Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `content` or `size`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a README that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge.
OutputReady
Your output will appear here
Complete the inputs, then click Run.
API README
GitHub Repository README API
Get a GitHub repository's README by repository URL, as the Markdown text the maintainers wrote, with its file name, path and size. Use it to learn what a project does, which models and tools it uses, and how to reach its authors.
Request
curl -X POST "https://api.sandbase.ai/v1/run" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "github/repository-readme", "url": "https://github.com/openai/whisper"}'
The result is returned in outputs[0].data. Lookups that find nothing fail with a not-found error.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | GitHub repository URL, e.g. https://github.com/openai/whisper. The README of the default branch is returned. |
requireFields | array | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example content or size, and it is served only by a source that returns ev |
Pricing
Billed at the actual cost of each call, about $0.0012 per request. A call can cost more when the first data source fails and another one answers. Failed calls and lookups that find nothing are not charged.
Start building
Send your first request
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/github/repository-readme" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"url": "https://github.com/openai/whisper"
}
SANDBASE_JSON
)
printf '%s\n' "$result"2. Authentication
Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
3. Parameters
requireFieldsarray
Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `content` or `size`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a README that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge.
4. Response
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.
Explore more
Related APIs
| API | Price | Response |
|---|---|---|
GitHub Repository READMEThis API GitHub | From $0.0012 per call | JSON |
GitHub | From $0.0012 per call | JSON |
GitHub | From $0.0012 per call | JSON |
GitHub | From $0.0012 per call | JSON |
GitHub | From $0.0012 per call | JSON |
GitHub | From $0.0012 per call | JSON |
Questions
FAQ
How do I use the GitHub Repository README API?
Send a POST request to https://api.sandbase.ai/v1/api/github/repository-readme with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.
How much does the GitHub Repository README API cost?
From $0.0012 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.
What parameters does the GitHub Repository README API accept?
Required: url (string). Optional: requireFields (array). The Parameters table and the Playground on this page list every field.
What does the GitHub Repository README API return?
A JSON response returned in the same HTTP request (synchronous).
Do I need a GitHub developer account or API key?
No. GitHub Repository README runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for GitHub API access separately.