Media

Giphy

Learn how to use Giphy with Composio

Overview

SLUG: GIPHY

Description

GIPHY is the first and largest GIF search engine, offering an extensive library of GIFs and Stickers for integration into applications.

Authentication Details

generic_api_key
stringRequired

Connecting to Giphy

Create an auth config

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

1

Select App

Navigate to Giphy.

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 Giphy 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
4giphy_auth_config_id = "ac_YOUR_GIPHY_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 Giphy 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, giphy_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 Giphy toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GIPHY"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Giphy Analytics Register

Description

Tool to register user interactions (view, click, send) with a GIF for analytics. Use when you have the analytics payload, timestamp, and user ID to record the event.

Action Parameters

action_type
stringRequired
analytics_response_payload
stringRequired
gif_id
stringRequired
random_id
stringRequired
ts
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: GIPHY Categories

Description

Tool to fetch a list of GIF categories on GIPHY. Use when you need to browse available categories before selecting one.

Action Parameters

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: GIPHY: Get Category by ID

Description

Tool to fetch metadata for a GIF category by its unique ID. Use when you need details for a specific category identifier.

Action Parameters

category_id
stringRequired

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: GIPHY: Category GIFs

Description

Tool to fetch GIFs associated with a specific GIF category. Use after retrieving category_id from the categories endpoint to get curated GIFs.

Action Parameters

bundle
string
category_id
stringRequired
country_code
string
limit
integerDefaults to 25
offset
integer
random_id
string
rating
string
region
string
remove_low_contrast
boolean

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: GIPHY Emoji

Description

Tool to fetch GIPHY emoji GIF objects. Use when you need a paginated list of GIPHY emojis.

Action Parameters

limit
integerDefaults to 25
offset
integer

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: Emoji Variations

Description

Tool to fetch variations for a specific emoji. Use when you have an emoji's GIF ID and want its variations.

Action Parameters

gif_id
stringRequired

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get GIF by ID

Description

Tool to fetch GIF metadata by its unique ID. Use when you have a valid GIF ID to retrieve metadata.

Action Parameters

country_code
string
gif_id
stringRequired
random_id
string
rating
string
region
string

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get GIFs by IDs

Description

Tool to fetch metadata for multiple GIFs by their IDs. Use when you need information on up to 100 known GIF IDs.

Action Parameters

country_code
string
ids
stringRequired
random_id
string
rating
string
region
string

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: Get Sticker by ID

Description

Tool to fetch sticker metadata by its unique ID. Use when you have a valid sticker ID to retrieve metadata.

Action Parameters

country_code
string
random_id
string
rating
string
region
string
sticker_id
stringRequired

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Stickers by IDs

Description

Tool to fetch metadata for multiple stickers by their IDs. Use when you need information on up to 100 known sticker IDs.

Action Parameters

country_code
string
ids
stringRequired
random_id
string
rating
string
region
string

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: Giphy Random GIF

Description

Tool to fetch a random GIF from Giphy. Use when you need a single random GIF, optionally filtered by tag or rating. Example: 'Get a random cat GIF rated G.'

Action Parameters

random_id
string
rating
string
tag
string

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Giphy Random Sticker

Description

Tool to fetch a single random sticker. Use when you need a random sticker, optionally filtered by tag or rating.

Action Parameters

country_code
string
random_id
string
rating
string
region
string
tag
string

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: GIPHY: Search GIFs

Description

Tool to search GIPHY's GIF library. Use when you need to find GIFs by keyword or phrase.

Action Parameters

bundle
string
country_code
string
fields
string
lang
string
limit
integerDefaults to 25
offset
integer
q
stringRequired
random_id
string
rating
string
region
string
remove_low_contrast
boolean

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: GIPHY: Search Stickers

Description

Tool to search GIPHY's sticker library. Use when you need to find stickers by keyword or phrase.

Action Parameters

bundle
string
country_code
string
lang
string
limit
integerDefaults to 25
offset
integer
q
stringRequired
random_id
string
rating
string
region
string
remove_low_contrast
boolean

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: GIPHY: Random Tag

Description

Tool to fetch a single random tag from Giphy. Use when you need a random search term tag, optionally filtered by a query term.

Action Parameters

random_id
string
tag
string

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: GIPHY Translate Sticker

Description

Tool to translate a term or phrase into a single sticker using GIPHY’s translation algorithm. Use after confirming the exact phrase to visualize as a sticker.

Action Parameters

country_code
string
random_id
string
rating
string
region
string
s
stringRequired

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Giphy Upload GIF

Description

Tool to upload a GIF or video file to GIPHY. Use when you need to create a new GIPHY entry from a local file or public URL. Requires developer API key and supports optional metadata.

Action Parameters

country_code
string
file
string
region
string
source_image_url
string
source_post_url
string
tags
string

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired