Developer API
ProPro: 1,000 calls/mo (50/hr) · Builder: 10,000 calls/mo (500/hr)
What is the Developer API?
The AWSYS.CO REST API lets you create, read, update, and delete short links programmatically, query analytics, and manage webhooks — all using standard HTTP requests and JSON. It is designed for developers building integrations, automation scripts, or AI-agent workflows. Authentication uses a long-lived API key that you generate from your account settings.
Requirements
API access requires a Pro or Builder plan. Generate an API key from Settings → Developer → API Keys. Keep your key secret — it grants full access to your account's links and analytics. Rotate keys regularly using the key management interface.
Step-by-step: Make your first API call
- Go to Settings → Developer → API Keys and click Generate New Key. Give it a descriptive label and copy the key — it is shown only once.
- Include the key in the
Authorizationheader of every request:Authorization: Bearer <your_api_key>. - To create a short link, send a
POSTtohttps://awsys.co/api/createShortwith body{"long": "<base64_url>"}wherelongis your destination URL encoded in Base64. - The response includes
shortUrl(the slug),url(the full short URL), andid(the link ID for future updates). - To list your links, use
GET https://awsys.co/api/links. Supports?page=,?limit=, and?folder=query parameters. - To update a link, send
PATCH https://awsys.co/api/links/:idwith a JSON body of the fields to change. - To delete a link, send
DELETE https://awsys.co/api/links/:id.
Configuration reference
| Endpoint | Method | Purpose |
|---|---|---|
/api/createShort | POST | Create a single short link |
/api/bulk | POST | Create up to 100 links in one request |
/api/links | GET | List your links (paginated) |
/api/links/:id | PATCH | Update link settings |
/api/links/:id | DELETE | Delete a link |
/api/analytics | GET | Query click analytics for a link |
/api/webhooks | GET / POST | List or create webhooks |
Common questions
Why must the URL be Base64-encoded?
The long field uses Base64 encoding to safely transmit URLs that contain special characters (such as &, =, or Unicode) without escaping issues in JSON. Use btoa(url) in a browser/Node.js or base64.b64encode(url.encode()).decode() in Python.
What happens when I exceed my monthly API call limit?
Requests beyond your monthly quota return HTTP 429 with an error body explaining the limit. Your links continue to redirect normally — only API management calls are gated. Quota resets at the start of each billing cycle.
Can I create multiple API keys?
Yes. Pro accounts can have up to 3 API keys; Builder accounts can have up to 10. Using separate keys per service (e.g., one for your automation script, one for your CI pipeline) lets you rotate or revoke individual keys without disrupting other integrations.
Where is the full API reference?
The complete endpoint reference with request/response schemas, code examples, and error codes is in the API Docs.