Y gy

Learn how to use Y gy with Composio

Overview

SLUG: Y_GY

Description

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.

Authentication Details

generic_api_key
stringRequired

Connecting to Y gy

Create an auth config

Use the dashboard to create an auth config for the Y gy toolkit. This allows you to connect multiple Y gy accounts to Composio for agents to use.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Y gy Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4y_gy_auth_config_id = "ac_YOUR_Y_GY_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Y gy for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, y_gy_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Y gy toolkit’s playground](https://app.composio.dev/app/Y gy)

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Tag

Description

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

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a tag by ID

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all tags

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Register User

Description

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.

Action Parameters

email
stringRequired
password
stringRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired