NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Hyperise connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Hyperise actions, such as "Create Client Account", "List Image Templates" and "Generate Personalized Short Link". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Hyperise, with input parameters and output schema.
HYPERISE_CREATE_CLIENT_ACCOUNTCreates a new Hyperise business/client account for personalized image campaigns. Use this to provision prospect records that can be linked to Hyperise image templates. The website field is required in the extras parameter. Returns the created account's ID, which can be used with other Hyperise actions like personalized short links.
Input parameters
Name of the client account (business name) to be created.
Contact email address for the client account.
Additional fields for client creation. REQUIRED: 'website' (e.g., 'https://example.com'). Optional fields include: first_name, last_name, business_phone, business_address, category, job_title, logo (URL), profile_image (URL), custom_text_1 through custom_text_4, custom_image_1 through custom_image_3, lat, long.
Parent business/agency ID to associate with the client account (used for organization purposes in the response).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HYPERISE_LIST_IMAGE_TEMPLATESRetrieves all active personalized image templates for the authenticated user. Use this tool when you need to: - Get a list of available Hyperise image templates - Find template IDs for use with other Hyperise actions - Check template dimensions, preview URLs, or metadata Returns an empty list if no templates exist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HYPERISE_PERSONALIZED_SHORT_LINKSGenerate a personalized short link with Open Graph metadata for rich link previews. This tool creates a shareable URL that: - Redirects to your destination page - Shows personalized image previews when shared on social media - Passes personalization data to your landing page Prerequisites: 1. At least one image template must exist in your Hyperise account 2. A custom link domain must be configured in Settings > Custom Domain Use HYPERISE_LIST_IMAGE_TEMPLATES first to get the image_hash parameter.
Input parameters
The destination URL that the short link will redirect to. Must be a valid, fully-qualified URL (e.g., https://example.com/landing).
The page description for Open Graph metadata. This appears as the link preview description when shared on social media or messaging apps.
The page title for Open Graph metadata. This appears as the link preview title when shared on social media or messaging apps.
The unique hash identifier for your Hyperise image template. Obtain this from the HYPERISE_LIST_IMAGE_TEMPLATES action or from your Hyperise dashboard under Image Templates.
Personalization data as key-value pairs. Common keys include: first_name, last_name, email, company_name, job_title, website, profile_image_url. Example: {'first_name': 'John', 'company_name': 'Acme'}
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HYPERISE_PROSPECT_BUSINESS_DATATool to perform CRUD operations on Hyperise business prospect records. Use when managing business data via the Hyperise API.
Input parameters
Record ID; required for retrieve, update, delete
Latitude coordinate
Logo URL or base64 image source
Longitude coordinate
Contact email; must be valid; required for create/update
Alternate contact phone number
Job title of contact
Gender of contact
Website URL; required for create/update
Category of the business
Job title of contact
Last name of contact
CRUD operation to perform: list, retrieve, create, update, or delete
First name of contact
Name of the business
Custom text field 1
Custom text field 2
Custom text field 3
Custom text field 4
Profile image URL or base64 source
Phone number of the business
Custom image 1 URL or base64
Custom image 2 URL or base64
Custom image 3 URL or base64
Address of the business
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HYPERISE_USER_AUTHENTICATIONTool to authenticate an API token and retrieve user details. Use after obtaining a valid API token from Hyperise settings.
Input parameters
Hyperise API token generated in account settings. Optional: if omitted, uses the token from the authenticated connection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 Hyperise actions on Nagent, including "Create Client Account", "List Image Templates" and "Generate Personalized Short Link". Create Client Account: Creates a new Hyperise business/client account for personalized image campaigns. Each action is listed on this page with its input parameters and its output.
Hyperise connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Client Account takes 3 required inputs: name, email and business_id. It also takes 1 optional input: extras. It returns data, error and successful.