Hyperise

Learn how to use Hyperise with Composio

Overview

SLUG: HYPERISE

Description

Hyperise is a personalization toolkit that enables sales and marketing teams to add dynamic, personalized elements to images, videos, and websites, enhancing engagement across various channels.

Authentication Details

generic_token
stringRequired

Connecting to Hyperise

Create an auth config

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

1

Select App

Navigate to Hyperise.

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 Hyperise 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
4hyperise_auth_config_id = "ac_YOUR_HYPERISE_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 Hyperise 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, hyperise_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 Hyperise toolkit’s playground

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

Tool List

Tool Name: Create Client Account

Description

Tool to create a new Hyperise client account. Use when an agency plan user needs to provision client sub-accounts.

Action Parameters

business_id
stringRequired
email
stringRequired
extras
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Image Templates

Description

Tool to list active image templates. Use when you need to retrieve all your current templates.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hyperise Prospect Business Data (CRUD)

Description

Tool to perform CRUD operations on Hyperise business prospect records. Use when managing business data via the Hyperise API.

Action Parameters

business_address
business_name
business_phone
category
custom_image_1
custom_image_2
custom_image_3
custom_text_1
custom_text_2
custom_text_3
custom_text_4
email
first_name
gender
id
job_title
last_name
lat
logo
long
operation
stringRequired
phone
profile_image
title
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: User Authentication

Description

Tool to authenticate an API token and retrieve user details. Use after obtaining a valid API token from Hyperise settings.

Action Parameters

api_token

Action Response

data
objectRequired
error
successful
booleanRequired