You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add fork notice explaining this is an actively maintained fork
- Remove ko-fi donation link
- Update usage viewer URLs to jacks0n.github.io
- Add "Changes from Original Repository" section with planned PRs
Copy file name to clipboardExpand all lines: README.md
+30-6Lines changed: 30 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,15 @@
1
1
# Copilot API Proxy
2
2
3
+
> [!NOTE]
4
+
> **Actively Maintained Fork**
5
+
> This is an actively maintained fork of [ericc-ch/copilot-api](https://github.com/ericc-ch/copilot-api). The original repository has been unmaintained since November 2025, with 22 open PRs waiting for review. This fork integrates community contributions and continues development. See [Changes from Original Repository](#changes-from-original-repository) for details.
6
+
3
7
> [!WARNING]
4
8
> This is a reverse-engineered proxy of GitHub Copilot API. It is not supported by GitHub, and may break unexpectedly. Use at your own risk.
5
9
6
10
> [!WARNING]
7
-
> **GitHub Security Notice:**
8
-
> Excessive automated or scripted use of Copilot (including rapid or bulk requests, such as via automated tools) may trigger GitHub's abuse-detection systems.
11
+
> **GitHub Security Notice:**
12
+
> Excessive automated or scripted use of Copilot (including rapid or bulk requests, such as via automated tools) may trigger GitHub's abuse-detection systems.
9
13
> You may receive a warning from GitHub Security, and further anomalous activity could result in temporary suspension of your Copilot access.
10
14
>
11
15
> GitHub prohibits use of their servers for excessive automated bulk activity or any activity that places undue burden on their infrastructure.
@@ -17,8 +21,6 @@
17
21
>
18
22
> Use this proxy responsibly to avoid account restrictions.
**Note:** If you are using [opencode](https://github.com/sst/opencode), you do not need this project. Opencode supports GitHub Copilot provider out of the box.
@@ -266,7 +268,7 @@ After starting the server, a URL to the Copilot Usage Dashboard will be displaye
266
268
npx copilot-api@latest start
267
269
```
268
270
2. The server will output a URL to the usage viewer. Copy and paste this URL into your browser. It will look something like this:
- If you use the `start.bat` script on Windows, this page will open automatically.
271
273
272
274
The dashboard provides a user-friendly interface to view your Copilot usage data:
@@ -276,7 +278,7 @@ The dashboard provides a user-friendly interface to view your Copilot usage data
276
278
- **Usage Quotas**: View a summary of your usage quotas for different services like Chat and Completions, displayed with progress bars for a quick overview.
277
279
- **Detailed Information**: See the full JSON response from the API for a detailed breakdown of all available usage statistics.
278
280
- **URL-based Configuration**: You can also specify the API endpoint directly in the URL using a query parameter. This is useful for bookmarks or sharing links. For example:
- `--rate-limit <seconds>`: Enforces a minimum time interval between requests. For example, `copilot-api start --rate-limit 30` will ensure there's at least a 30-second gap between requests.
350
352
- `--wait`: Use this with `--rate-limit`. It makes the server waitfor the cooldown period to end instead of rejecting the request with an error. This is useful for clients that don't automatically retry on rate limit errors.
351
353
- If you have a GitHub business or enterprise plan account with Copilot, use the `--account-type` flag (e.g., `--account-type business`). See the [official documentation](https://docs.github.com/en/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network#configuring-copilot-subscription-based-network-routing-for-your-enterprise-or-organization) for more details.
354
+
355
+
## Changes from Original Repository
356
+
357
+
This fork includes the following improvements over the original [ericc-ch/copilot-api](https://github.com/ericc-ch/copilot-api):
358
+
359
+
### New Features
360
+
361
+
- **GitHub Enterprise Support** - Use with GitHub Enterprise Server/Cloud instances ([#128](https://github.com/ericc-ch/copilot-api/pull/128))
362
+
- **API Key Authentication** - Secure your proxy with multiple API keys ([#144](https://github.com/ericc-ch/copilot-api/pull/144))
363
+
- **Host Binding** - Restrict server to specific network interface via `--host` ([#157](https://github.com/ericc-ch/copilot-api/pull/157))
364
+
- **Claude Thinking/Reasoning** - Support for Claude model thinking blocks ([#167](https://github.com/ericc-ch/copilot-api/pull/167))
365
+
- **Prometheus Metrics** - Monitoring via `/metrics` endpoint ([#132](https://github.com/ericc-ch/copilot-api/pull/132))
366
+
- **Responses API** - Support for `/v1/responses` endpoint ([#170](https://github.com/ericc-ch/copilot-api/pull/170))
0 commit comments