# Shorten rest

```json
{
  "name": "Shorten rest",
  "slug": "shorten_rest",
  "url": "https://composio.dev/toolkits/shorten_rest",
  "markdown_url": "https://composio.dev/toolkits/shorten_rest.md",
  "logo_url": "https://logos.composio.dev/api/shorten_rest",
  "categories": [
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:26:02.046Z"
}
```

![Shorten rest logo](https://logos.composio.dev/api/shorten_rest)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Shorten rest MCP or direct API to shorten links, generate branded URLs, manage link destinations, and track click analytics through natural language.

## Summary

Shorten.REST is a link shortening and management platform for generating branded, trackable URLs. It helps you boost engagement and analyze link performance with advanced analytics.

## Categories

- marketing & social media

## Toolkit Details

- Tools: 6

## Images

- Logo: https://logos.composio.dev/api/shorten_rest

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Shorten.REST.
  - Setup:
    - Configure Api Key credentials for Shorten.REST.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Shorten this long marketing campaign URL
- Create branded short link for event signup
- Track click stats for my recent short link
- Generate bulk short links for product pages

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `SHORTEN_REST_CREATE_ALIAS` | Create Alias | Tool to create a new alias (short URL) under a specified domain. Use when you need to shorten a URL. If no domain is specified, the alias will be attached to the default domain Short.fyi. You can override domain-level Meta Tags and Tracking Snippets by specifying them for each URL. |
| `SHORTEN_REST_DELETE_ALIAS` | Delete Alias | Tool to delete a single alias by providing alias and domain. Use when you need to remove an existing shortened URL. If no domain is provided, the API searches for the matching alias within the Short.fyi domain. |
| `SHORTEN_REST_GET_ALIASES` | Get Aliases | Tool to retrieve all URL aliases of the authenticated user. Use when you need to list existing aliases (supports pagination). |
| `SHORTEN_REST_GET_CLICKS` | Get click data for aliases | Tool to retrieve click data for shortened URLs. Use to check click analytics for your aliases. Returns a list of click records which may be empty if no clicks have occurred yet. Returned records may represent a limited window or subset of historical clicks rather than complete per-click logs. |
| `SHORTEN_REST_LIST_ALIASES_BY_DOMAIN` | List aliases by domain | Tool to retrieve all alias names associated with your account and a given domain. Results are in descending order by creation date. Use when you need to list alias names (not full details) for a specific domain with pagination support. |
| `SHORTEN_REST_UPDATE_ALIAS` | Update Alias | Tool to update an existing short URL alias by providing its alias name and domain. Use when you need to modify destinations, metatags, or snippets for an existing alias. IMPORTANT: When updating array properties (like destinations), the entire array is replaced, so you must include all existing records you want to keep. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Shorten rest Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Shorten rest actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Shorten this URL: https://www.example.com/summer-sale-offer'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Shorten this URL: https://www.example.com/summer-sale-offer'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Shorten rest tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Create a branded short link for https://example.com')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Create a branded short link for https://example.com' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Shorten rest Integration

- Supports both Shorten rest MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for creating, updating, and tracking Shorten rest links

### 2. Managed Auth

- Built-in API key handling with secure storage
- Central place to manage, scope, and revoke Shorten rest access
- Per user and per environment credentials so you never hard-code secrets

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Shorten rest
- Scoped, least privilege access to Shorten rest resources
- Full audit trail of agent actions to support review and compliance

## Use Shorten rest with any AI Agent Framework

Choose a framework you want to connect Shorten rest with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/shorten_rest/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/shorten_rest/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/shorten_rest/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/shorten_rest/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/shorten_rest/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/shorten_rest/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/shorten_rest/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/shorten_rest/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/shorten_rest/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/shorten_rest/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/shorten_rest/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/shorten_rest/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/shorten_rest/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/shorten_rest/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/shorten_rest/framework/autogen)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### Do I need my own developer credentials to use Shorten rest with Composio?

Yes, Shorten rest requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)