Skip to content

Document alternative API endpoints in README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gugu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document alternative API endpoints in README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ Creates a new Short.io client instance.
| `config.publicKey` | `string` | Yes | Your Short.io public API key |
| `config.baseUrl` | `string` | No | Custom API base URL (default: `https://api.short.io`) |

**Alternative API endpoints:**

| Endpoint | Use case |
|----------|----------|
| `https://api.short.io` | Default — standard API |
| `https://enterprise-api.short.io` | Enterprise customers with dedicated IPs |
| `https://api.shortio.cn` | Users in mainland China |
Comment on lines +66 to +72
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternative endpoints list is not clearly tied back to config.baseUrl. Consider adding a short sentence here explaining that users should set createClient({ baseUrl: ... }) to one of these values (and whether a trailing slash is expected), otherwise the table is a bit ambiguous about how to apply it.

Copilot uses AI. Check for mistakes.

### `client.createLink(request)`

Creates a new short link.
Expand Down
Loading