canonical: https://jentic.com/apis/shorten.rest/shorten-rest

# Shorten.REST API Documentation

Introduction The Shorten.rest API allows you to programmatically create short URLs (an 'alias') for longer URL (a 'destination'). Each alias you create can be used to redirect the end user (person clicking on the link) to one or more destination URLs A default destination is always set and specific destinations can be set to redirect the end user to preferred destinations based. The API exposes 7 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create alias, get alias. Covers 7 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for maps and geolocation only.

## Capabilities

- Create alias
- Get alias
- Update alias
- Delete alias
- Monitor Shorten.REST API Documentation operational status and events

## Use cases

### Maps and Geolocation Operations

Use the Shorten.REST API Documentation to perform maps geolocation operations programmatically. The API provides 7 endpoints covering core functionality including create alias, get alias, update alias.

Example prompt: Call POST /aliases to create alias

### Automated Alias Management

Automate alias operations by combining multiple Shorten.REST API Documentation endpoints. Agents can get alias and then update alias in a single workflow.

Example prompt: Call GET /aliases to get alias, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Shorten.REST API Documentation endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create alias', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/aliases` | Create alias |
| GET | `/aliases` | Get alias |
| PUT | `/aliases` | Update alias |
| DELETE | `/aliases` | Delete alias |
| GET | `/aliases/all` | Get aliases by domain |
| GET | `/clicks` | Get clicks |
| POST | `/clicks/pg` | Get clicks statistics |

## Key resources

- **Alias** — **Operations:** Create, Get, Update, Delete, Get List
- **Click** — **Operations:** Get List

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 59 / 100
- **View full report:** https://jentic.com/apis/shorten.rest/shorten-rest/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Shorten.REST API by hand means sending your API key on every request against api.shorten.rest and parsing its alias and click responses yourself. Through Jentic you install once, import the Shorten.REST API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Shorten.REST works on the /aliases collection with the target in the request body rather than as an owned path resource, so you limit the agent to the operations it needs, such as creating or listing aliases, and destructive ones like alias deletion stay out unless you add them.
- **Credential handling:** Your Shorten.REST key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a short alias' or 'list click data', and Jentic returns the matching Shorten.REST operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Here** — Alternative maps geolocation API
- **Tomtom** — Alternative maps geolocation API
- **Googleapis** — Complementary maps geolocation API

## FAQ

### What authentication does the Shorten.REST API Documentation use?

The Shorten.REST API Documentation uses an API key passed in the `x-api-key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create alias with the Shorten.REST API Documentation?

Yes. Use the POST /aliases endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Shorten.REST API Documentation?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create alias through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create alias'. Jentic returns the matching Shorten.REST API Documentation operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Shorten.REST API Documentation have?

The Shorten.REST API Documentation exposes 7 endpoints covering alias, click operations.

### Can I limit what my agent is allowed to do with the Shorten.REST API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which Shorten.REST operations and credentials your agent may use. Shorten.REST acts on the /aliases collection with the target passed in the request body rather than as an owned path, so you can grant only the operations the agent needs, such as creating aliases, listing aliases by domain, or reading click statistics. Destructive operations like deleting an alias stay off unless you explicitly add them.