Getting Started with the AWSYS.CO API
REST API reference for developers
The AWSYS.CO REST API lets you create and manage short links, retrieve analytics, and configure webhooks programmatically. All endpoints require a Pro plan or higher.
Base URL
All API requests are made to the following base URL. There is no versioning prefix — the API is stable and backwards-compatible.
https://awsys.coPrerequisites
Before making your first API call you will need:
- An AWSYS.CO account on the Pro plan or higher
- An API key — generate one in Settings → API
See API Authentication for full details on generating and using your API key.
Your First API Call
Create a short link in five lines of curl. The long field value must be the destination URL encoded as Base64.
curl -X POST https://awsys.co/api/createShort \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"long": "aHR0cHM6Ly95b3VyLXVybC5jb20="}'The response includes a shortUrl (the slug) and a url (the full clickable URL):
{
"shortUrl": "abc123",
"url": "https://awsys.co/abc123"
}Base64 encoding: The long field must always be the destination URL encoded in Base64. For example, https://your-url.com becomes aHR0cHM6Ly95b3VyLXVybC5jb20=. Use btoa(url) in JavaScript or base64.b64encode(url.encode()).decode() in Python.
Endpoint Groups
| Group | Base Path | Description | Docs |
|---|---|---|---|
| Links | /api/createShort, /api/links |
Create, list, update, and delete short links | Links API |
| Analytics | /api/analytics |
Per-link and account-level click statistics | Analytics API |
| Webhooks | /api/webhooks |
Register endpoints to receive real-time link events | Webhooks |
| Bulk | /api/bulk |
Create up to 1,000 short links in a single request | Bulk Operations |
| User / API | /api/user, /api/keys |
Manage your account and API keys | See Settings in the dashboard |
OpenAPI Specification
A machine-readable OpenAPI 3.0 specification is available at /openapi.yaml. You can import it into Postman, Insomnia, or any OpenAPI-compatible client.
Next Steps
- Authentication — how to generate and use your API key securely
- Links API — create, update, list, and delete short links
- Webhooks — receive real-time events when links are clicked or modified
- Rate Limits — understand per-plan request quotas
- Error Reference — all HTTP status codes and machine-readable error codes