# 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.

Source: https://www.sandbase.ai/apis/github/repository-readme
API reference: https://www.sandbase.ai/apis/github/repository-readme#api

## Facts

- Provider: GitHub
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/github/repository-readme`
- Price: From $0.0012 per call
- Capabilities: api, github, developer, code
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/github/repository-readme` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `url` | string | yes |  |
| `requireFields` | array | no |  |

## 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.

## 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

```bash
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.