# Y gy

y.gy is a URL shortener and QR code generator that allows users to create short, memorable links from long URLs, customize them with unique endings, and integrate with an API for programmatic link creation.

- **Category:** url shortener
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `Y_GY`
- **Version:** 20260223_00

## Tools

### Create Y.gy Link

**Slug:** `Y_GY_CREATE_LINK`

Tool to create a comprehensive Y.gy shortened link with advanced features. Supports custom domains, suffixes, QR codes, password protection, expiration dates, social media previews, device-specific redirects, and webhook integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | An optional descriptive internal name or title associated with the link |
| `tags` | array | No | An array of tag ids to add to the link, as returned by the tags API |
| `domain` | string | No | The domain of the short link. Defaults to y.gy. Custom domains must be verified via dashboard first. |
| `suffix` | string | No | The end of the link. If the suffix is '123', the short link might look like 'y.gy/123' |
| `og_image` | string | No | The image URL that shows on social link previews on social media |
| `og_title` | string | No | The title that shows on social link previews on social media |
| `password` | string | No | If you want to password-protect your page, you can include a password here |
| `disable_png` | string | No | Query parameter to turn off creating a PNG version of the QR code (set to 'true'). Useful for high-volume link creation. |
| `webhook_url` | string | No | URL to which real-time updates get posted via webhook integration |
| `og_description` | string | No | The description that shows on social link previews on social media |
| `destination_url` | string | Yes | The short link will redirect to this destination URL |
| `expiration_date` | string | No | If you want the link to be inaccessible after a given date, add the datetime here |
| `webhook_auth_key` | string | No | The authentication key used to secure webhook interactions |
| `ios_link_destination` | string | No | If provided, the short link will redirect to this destination URL on iOS devices |
| `qr_code_background_hex` | string | No | Background color for the QR PNG/SVG. Include # (e.g., '#CF245A') |
| `qr_code_foreground_hex` | string | No | Foreground color for the QR PNG/SVG. Include # (e.g., '#CF245A') |
| `android_link_destination` | string | No | If provided, the short link will redirect to this destination URL on Android devices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `Y_GY_CREATE_TAG`

Tool to create a new tag. Use after determining the tag name to categorize links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The desired name for the new tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Y.GY Short Link

**Slug:** `Y_GY_DELETE_SHORT_LINK`

Tool to delete a specific short link by its ID. Use when you need to remove a short link after confirming its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the short link to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a tag by ID

**Slug:** `Y_GY_DELETE_TAG`

Tool to delete a tag. Use when you need to remove a tag by its ID after confirming it exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the tag to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all links

**Slug:** `Y_GY_GET_ALL_LINKS`

Tool to fetch all short links with optional pagination. Use when you need to list existing links with filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Filter links by tag |
| `page` | integer | No | Page number to retrieve |
| `limit` | integer | No | Number of items per page |
| `search` | string | No | Search term to filter links |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all tags

**Slug:** `Y_GY_GET_ALL_TAGS`

Tool to retrieve all tags associated with the organization. Use when you need to list all available tags for categorizing resources.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Link Details

**Slug:** `Y_GY_GET_LINK`

Tool to retrieve a specific short link by its ID. Returns the complete link object including destination URL, QR codes, tags, and all configuration options. Use when you need full details about a short link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the link as returned by the y.gy API originally |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register User

**Slug:** `Y_GY_REGISTER_USER`

Tool to register a new user account. Use when onboarding a new user to the y.gy system with their chosen username, password, and email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address for the new user account. |
| `password` | string | Yes | Password for the new user account. |
| `username` | string | Yes | Desired username for the new user account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
