---
name: shorten-rest-api-documentation
description: "Shorten.REST API Documentation API skill. Use when working with Shorten.REST API Documentation for aliases, clicks. Covers 6 endpoints."
version: 1.0.0
generator: lapsh
---

# Shorten.REST API Documentation
API version: 1.0.0

## Auth
ApiKey x-api-key in header

## Base URL
https://api.shorten.rest

## Setup
1. Set your API key in the appropriate header
2. GET /aliases -- verify access
3. POST /aliases -- create first aliases

## Endpoints

6 endpoints across 2 groups. See references/api-spec.lap for full details.

### aliases
| Method | Path | Description |
|--------|------|-------------|
| GET | /aliases | Get alias |
| POST | /aliases | Create alias |
| PUT | /aliases | Update alias |
| DELETE | /aliases | Delete alias |
| GET | /aliases/all | Get aliases by domain |

### clicks
| Method | Path | Description |
|--------|------|-------------|
| GET | /clicks | Get clicks |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all aliases?" -> GET /aliases
- "Create a aliase?" -> POST /aliases
- "List all all?" -> GET /aliases/all
- "List all clicks?" -> GET /clicks
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get shorten-rest-api-documentation -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search shorten-rest-api-documentation
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)