canonical: https://jentic.com/apis/short.io/short

# Short.io API

short.io/main version 1.0.0. The API exposes 54 endpoints secured with apiKey authentication.

## For AI agents

Programmatically fetch and inspect opengraph tags for a url (public, hcaptcha-protected), get link opengraph properties. Covers 54 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Fetch and inspect OpenGraph tags for a URL (public, hCaptcha-protected)
- Get link opengraph properties
- Set link opengraph properties
- Create link country
- Delete link country

## Use cases

### Developer Tools Operations

Use the Short.io API to perform developer tools operations programmatically. The API provides 54 endpoints covering core functionality including fetch and inspect opengraph tags for a url (public, hcaptcha-protected), get link opengraph properties, set link opengraph properties.

Example prompt: Call POST /links/opengraph/debug to fetch and inspect opengraph tags for a url (public, hcaptcha-protected)

### Automated Domains Management

Automate domains operations by combining multiple Short.io API endpoints. Agents can get link opengraph properties and then set link opengraph properties in a single workflow.

Example prompt: Call GET /links/opengraph/{domainId}/{linkId} to get link opengraph properties, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Short.io API 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 'fetch and inspect opengraph tags for a url (public, hcaptcha-protected)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /links/opengraph/debug | Fetch and inspect OpenGraph tags for a URL (public, hCaptcha-protected) |
| GET | /links/opengraph/{domainId}/{linkId} | Get link opengraph properties |
| PUT | /links/opengraph/{domainId}/{linkId} | Set link opengraph properties |
| POST | /link_country/{linkId} | Create link country |
| GET | /link_country/{linkId} | Get link countries |
| POST | /link_country/bulk/{linkId} | Create link countries in bulk |
| DELETE | /link_country/{linkId}/{country} | Delete link country |
| POST | /link_region/{linkId} | Add region targeting to link |

## Key resources

- **Domains** — Operations for domains
- **Link_Country** — Operations for link_country
- **Link_Region** — Operations for link_region
- **Links** — Operations for links
- **Tags** — Operations for tags

## Why Jentic

- **Setup:** Wiring the Short.io API by hand means sending your key in the Authorization header on every request against api.short.io and parsing its link, country, and region responses yourself. Through Jentic you install once, import the Short.io API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Short.io puts the link id in the URL path (/link_country/{linkId}, /link_region/{linkId}), so a rule can pin your agent to one link: it can read and set country and region targeting for that link and nothing else. You choose the operations it may call, so destructive ones like removing a country target are not included unless you add them.
- **Credential handling:** Your Short.io 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 'set country targeting for a link' or 'inspect OpenGraph tags for a link', and Jentic returns the matching Short.io operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Short.io API use?

The Short.io API uses an API key passed in the `Authorization` 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 fetch and inspect opengraph tags for a url (public, hcaptcha-protected) with the Short.io API?

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

### What are the rate limits for the Short.io API?

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 fetch and inspect opengraph tags for a url (public, hcaptcha-protected) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'fetch and inspect opengraph tags for a url (public, hcaptcha-protected)'. Jentic returns the matching Short.io API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Short.io API have?

The Short.io API exposes 54 endpoints covering domains, link_country, link_region operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Short.io operations and credentials your agent may use. Since the link id sits in the URL path (for example /link_country/{linkId} and /link_region/{linkId}), a rule can pin the agent to a single link so it only reads and sets that link's country and region targeting and nothing else. You choose the operations it may call, so destructive ones like deleting a country target from a link stay out unless you add them.
