# Table of Contents - [Welcome - Agent.ai Documentation](#welcome-agent-ai-documentation) - [Introduction - Agent.ai Documentation](#introduction-agent-ai-documentation) - [Introduction - Agent.ai Documentation](#introduction-agent-ai-documentation) - [Get User List - Agent.ai Documentation](#get-user-list-agent-ai-documentation) - [Get User Input - Agent.ai Documentation](#get-user-input-agent-ai-documentation) - [Get User File - Agent.ai Documentation](#get-user-file-agent-ai-documentation) - [Builder Overview - Agent.ai Documentation](#builder-overview-agent-ai-documentation) - [Get User KBs and Files - Agent.ai Documentation](#get-user-kbs-and-files-agent-ai-documentation) - [Click Go to Continue - Agent.ai Documentation](#click-go-to-continue-agent-ai-documentation) - [Wait for User Confirmation - Agent.ai Documentation](#wait-for-user-confirmation-agent-ai-documentation) - [Get Data from User's Uploaded Files - Agent.ai Documentation](#get-data-from-user-s-uploaded-files-agent-ai-documentation) - [Enrich with Breeze Intelligence - Agent.ai Documentation](#enrich-with-breeze-intelligence-agent-ai-documentation) - [Get Data from Builder's Knowledge Base - Agent.ai Documentation](#get-data-from-builder-s-knowledge-base-agent-ai-documentation) - [YouTube Channel Data - Agent.ai Documentation](#youtube-channel-data-agent-ai-documentation) - [Get Bluesky Posts - Agent.ai Documentation](#get-bluesky-posts-agent-ai-documentation) - [Get Instagram Followers - Agent.ai Documentation](#get-instagram-followers-agent-ai-documentation) - [YouTube Search Results - Agent.ai Documentation](#youtube-search-results-agent-ai-documentation) - [Get HubSpot CRM Object - Agent.ai Documentation](#get-hubspot-crm-object-agent-ai-documentation) - [Search Results - Agent.ai Documentation](#search-results-agent-ai-documentation) - [Google News Data - Agent.ai Documentation](#google-news-data-agent-ai-documentation) - [Get Recent Tweets - Agent.ai Documentation](#get-recent-tweets-agent-ai-documentation) - [Get Instagram Profile - Agent.ai Documentation](#get-instagram-profile-agent-ai-documentation) - [Get LinkedIn Activity - Agent.ai Documentation](#get-linkedin-activity-agent-ai-documentation) - [Add HubSpot CRM Object - Agent.ai Documentation](#add-hubspot-crm-object-agent-ai-documentation) - [Web Page Screenshot - Agent.ai Documentation](#web-page-screenshot-agent-ai-documentation) - [Get LinkedIn Profile - Agent.ai Documentation](#get-linkedin-profile-agent-ai-documentation) - [Search Bluesky Posts - Agent.ai Documentation](#search-bluesky-posts-agent-ai-documentation) - [Get Twitter Users - Agent.ai Documentation](#get-twitter-users-agent-ai-documentation) - [Web Page Content - Agent.ai Documentation](#web-page-content-agent-ai-documentation) - [Get HubSpot Owners - Agent.ai Documentation](#get-hubspot-owners-agent-ai-documentation) - [If/Else Statement - Agent.ai Documentation](#if-else-statement-agent-ai-documentation) - [Use GenAI (LLM) - Agent.ai Documentation](#use-genai-llm-agent-ai-documentation) - [Update HubSpot CRM Object - Agent.ai Documentation](#update-hubspot-crm-object-agent-ai-documentation) - [Get HubSpot Object Properties - Agent.ai Documentation](#get-hubspot-object-properties-agent-ai-documentation) - [Get Assigned Company - Agent.ai Documentation](#get-assigned-company-agent-ai-documentation) - [Create Blog Post - Agent.ai Documentation](#create-blog-post-agent-ai-documentation) - [Save To Google Doc - Agent.ai Documentation](#save-to-google-doc-agent-ai-documentation) - [Set Variable - Agent.ai Documentation](#set-variable-agent-ai-documentation) - [Generate Image - Agent.ai Documentation](#generate-image-agent-ai-documentation) - [End If/Else/For Statement - Agent.ai Documentation](#end-if-else-for-statement-agent-ai-documentation) - [Continue or Exit Workflow - Agent.ai Documentation](#continue-or-exit-workflow-agent-ai-documentation) - [Show User Output - Agent.ai Documentation](#show-user-output-agent-ai-documentation) - [Send Message - Agent.ai Documentation](#send-message-agent-ai-documentation) - [For Loop - Agent.ai Documentation](#for-loop-agent-ai-documentation) - [Post to Bluesky - Agent.ai Documentation](#post-to-bluesky-agent-ai-documentation) - [Convert File - Agent.ai Documentation](#convert-file-agent-ai-documentation) - [Call Serverless Function - Agent.ai Documentation](#call-serverless-function-agent-ai-documentation) - [Add to List - Agent.ai Documentation](#add-to-list-agent-ai-documentation) - [Invoke Web API - Agent.ai Documentation](#invoke-web-api-agent-ai-documentation) - [Format Text - Agent.ai Documentation](#format-text-agent-ai-documentation) - [Invoke Other Agent - Agent.ai Documentation](#invoke-other-agent-agent-ai-documentation) - [Get Variable from Database - Agent.ai Documentation](#get-variable-from-database-agent-ai-documentation) - [Store Variable to Database - Agent.ai Documentation](#store-variable-to-database-agent-ai-documentation) --- # Welcome - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Get Started Welcome [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#what-is-agent-ai) What is Agent.AI? ------------------------------------------- Agent.AI is the #1 Professional Network For A.I. Agents (also, the only professional network for A.I. agents). It is a marketplace and professional network for AI agents and the people who love them. Here, you can discover, connect with and hire AI agents to do useful things. For Users --------- Discover, connect with and hire AI agents to do useful things For Builders ------------ Build advanced AI agents using an extensible, no-code platform with data tools and access to frontier LLMS. [​](#do-i-have-to-be-a-developer-to-build-ai-agents) Do I have to be a developer to build AI agents? ------------------------------------------------------------------------------------------------------- Not at all! Our platform is a no-code platform, where you can drag and drop various components together to build AI agents. Our builder had dozens of actions that can grab data from various data sources (i.e. X. Bluesky, LinkedIn, Google) and use any frontier LLM (i.e. OpenAI’s 4o and o1, Google’s Gemini models, Anthropic’s Claude models, as well as open source Meta Llama 3s and Mistral models) in an intuitive interface. For those users looking for can code and are looking for more advanced functionality, you can even use third party APIs and write serverless functions to interact with your agent’s steps. [Builder Overview](/builder/overview) On this page * [What is Agent.AI?](#what-is-agent-ai) * [Do I have to be a developer to build AI agents?](#do-i-have-to-be-a-developer-to-build-ai-agents) --- # Introduction - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation API Documentation Introduction [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) Coming soon! --- # Introduction - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Recipes Introduction [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) Coming soon! --- # Get User List - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get User List [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- The “Get User List” action collects a list of items entered by users and splits them based on a specified delimiter or newline. ### [​](#use-cases) Use Cases * **Batch Data Input**: Gather a list of email addresses or item names. * **Bulk Selection**: Allow users to input multiple options in one field. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#user-prompt) User Prompt * **Description**: Write a clear prompt to guide users on what information is required. * **Example**: “Enter the list of email addresses separated by commas.” * **Required**: Yes ### [​](#list-delimiter-leave-blank-for-newline) List Delimiter (leave blank for newline) * **Description**: Specify the character that separates the list items. * **Example**: Use a comma (,) for “item1,item2,item3” or leave blank for newlines. * **Required**: No ### [​](#required) Required? * **Description**: Mark this checkbox if this input is mandatory. * **Example**: Enable if a response is essential to proceed in the workflow. * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a unique variable name for the input value. * **Example**: “email\_list” or “item\_names.” * **Validation**: * Only letters, numbers, and underscores (\_) are allowed. * No spaces, special characters, or dashes. * **Regex**: `^[a-zA-Z0-9_]+$` * **Hint**: This variable will be used to reference the list in subsequent steps. * **Required**: Yes [Get User File](/actions/get_user_file) [Get User KBs and Files](/actions/get_user_knowledge_base_and_files) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [User Prompt](#user-prompt) * [List Delimiter (leave blank for newline)](#list-delimiter-leave-blank-for-newline) * [Required?](#required) * [Output Variable Name](#output-variable-name) --- # Get User Input - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get User Input [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- The “Get User Input” action allows you to capture dynamic responses from users, such as text, numbers, URLs, and dropdown selections. This action is essential for workflows that require specific input from users to proceed. ### [​](#use-cases) Use Cases * **Survey Form**: Collect user preferences or feedback. * **Authentication**: Prompt for email addresses or verification codes. * **Customized Workflow**: Ask users to select options to determine the next steps. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#input-type) Input Type * **Description**: Choose the type of input you want to capture from the user. * **Options**: * **Text**: Open-ended text input. * **Number**: Numeric input only. * **Yes/No**: Binary selection. * **Textarea**: Multi-line text input. * **URL**: Input limited to URLs. * **Website Domain**: Input limited to domains. * **Dropdown (single)**: Single selection from a dropdown. * **Dropdown (multiple)**: Multiple selections from a dropdown. * **Multi-Item Selector**: Allows selecting multiple items. * **Multi-Item Selector (Table View)**: Allows selecting multiple items in a table view. * **Radio Select (single)**: Single selection using radio buttons. * **HubSpot Portal**: Select a portal. * **HubSpot Company**: Select a company. * **Knowledge Base**: Select a knowledge base. * **Hint**: Select the appropriate input type based on your data collection needs. For example, use “Text” for open-ended input or “Yes/No” for binary responses. * **Required**: Yes ### [​](#user-prompt) User Prompt * **Description**: Write a clear prompt to guide users on what information is required. * **Example**: “Please enter your email address” or “Select your preferred contact method.” * **Required**: Yes ### [​](#default-value) Default Value * **Description**: Provide a default response that appears automatically in the input field. * **Example**: “[\[email protected\]](/cdn-cgi/l/email-protection#7c19041d110c10193c1813111d1512521f1311) ” for an email field. * **Hint**: Use this field to pre-fill common or expected responses to simplify input for users. * **Required**: No ### [​](#required) Required? * **Description**: Mark this checkbox if this input is mandatory. * **Example**: Enable if a response is essential to proceed in the workflow. * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a unique variable name for the input value. * **Example**: “user\_email” or “preferred\_contact.” * **Validation**: * Only letters, numbers, and underscores (\_) are allowed. * No spaces, special characters, or dashes. * **Regex**: `^[a-zA-Z0-9_]+$` * **Hint**: This variable will be used to reference the input value in subsequent steps. * **Required**: Yes [Builder Overview](/builder/overview) [Get User File](/actions/get_user_file) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Input Type](#input-type) * [User Prompt](#user-prompt) * [Default Value](#default-value) * [Required?](#required) * [Output Variable Name](#output-variable-name) --- # Get User File - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get User File [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- The “Get User File” action allows users to upload files for processing, storage, or review. ### [​](#use-cases) Use Cases * **Resume Collection**: Upload resumes in PDF format. * **File Processing**: Gather data files for analysis. * **Document Submission**: Collect required documentation from users. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#user-prompt) User Prompt * **Description**: Provide clear instructions for users to upload files. * **Example**: “Upload your resume as a PDF.” * **Required**: Yes ### [​](#required) Required? * **Description**: Mark this checkbox if file upload is necessary for the workflow to proceed. * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name for the uploaded files. * **Example**: “user\_documents” or “uploaded\_images.” * **Validation**: * Only letters, numbers, and underscores (\_) are allowed. * No spaces, special characters, or dashes. * **Regex**: `^[a-zA-Z0-9_]+$` * **Hint**: This variable will be used to reference the files in subsequent steps. * **Required**: Yes ### [​](#show-only-files-uploaded-in-the-current-session) Show Only Files Uploaded in the Current Session * **Description**: Restrict access to files uploaded only during the current session. * **Required**: No [Get User Input](/actions/get_user_input) [Get User List](/actions/get_user_list) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [User Prompt](#user-prompt) * [Required?](#required) * [Output Variable Name](#output-variable-name) * [Show Only Files Uploaded in the Current Session](#show-only-files-uploaded-in-the-current-session) --- # Builder Overview - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Builder Builder Overview [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) The Agent.AI Builder is a no-code tool that allows users at all technical levels to build powerful agentic AI applications in minutes. Once you sign up for your Agent.AI account, enable your Builder account by clicking on “Agent Builder” in the menu bar. Then, head over to the [Agent Builder](https://agent.ai/builder/agents) to get started. [​](#create-your-first-agent) Create Your First Agent -------------------------------------------------------- To create an agent, click on the “Create Agent” modal. You can either start building an agent from scratch or start building from one of our existing templates. Let’s start by building an agent from scratch. Don’t worry, it’s easier than it sounds! [​](#settings) Settings -------------------------- The builder has 5 different sections: Settings, Triggers, Actions, Sharing, and Advanced. Most information is optional, so don’t if you don’t know what some of those words mean. Let’s start with the settings panel. Here we define how the agent will show up when users try to use it and how it will show up in the marketplace. #### [​](#required-information) Required Information The following information is required: * Agent Name: Name your agent based on its function. Make this descriptive to reflect what the agent does (e.g., “Data Fetcher,” “Customer Profile Enricher”). * Agent Description: Describe what your agent is built to do. This can include any specific automation or tasks it handles (e.g., “Fetches and enriches customer data from LinkedIn profiles”). * Agent Tag(s): Add tags that make it easier to search or categorize your agent for quick access. #### [​](#optional-information) Optional Information The following information is not required, but will help people get a better understanding of what your agent can do and will help it stand out: * Icon URL: You can add a visual representation by uploading an icon or linking to an image file that represents your agent’s purpose. * Sharing and Visibility: * Private: unlisted, where only people with the link can use the agent * User only: only the author can use this agent * Public: all users can use this agent * Expected Runtime: Gives users an indication as to how long the agent will take to run, on average. It also allows the builder to create a progress bar as the agent executes. * Video Demo: Provide the public video URL of a live demo of your agent in action from Youtube, Loom, Vimeo, or Wistia, or upload a local recording. You can copy this URL from the video player on any of these sites. This video will be shown to Agent.AI site explorers to help better understand the value and behavior of your agent. * Agent Username: This is the unique identifier for your agent, which will be used in the agent URL. [​](#trigger) Trigger ------------------------ Triggers determine when the agent will run. You can set up the following trigger types: #### [​](#manual) Manual Agents can always be run manually, but selecting ‘Manual Only’ ensures this agent can only be triggered directly from Agent.AI #### [​](#user-configured-schedule) User configured schedule Enabling user configured schedules allows users of your agent to set up recurring runs of the agent using inputs from their previously defined inputs. #### [​](#enable-agent-via-email) Enable agent via email When this setting is enabled, the agent will also be accessible via email. Users can just email the agent’s email address and they’ll get a reply with the full response directly. #### [​](#hubspot-contact-company-added) HubSpot Contact/Company Added Automatically trigger the agent when a new contact or company is added to HubSpot, a useful feature for CRM automation. #### [​](#webhook) Webhook By enabling a webhook, the agent can be triggered whenever an external system sends a request to the specified endpoint. This ensures your agent remains up to date and reacts instantly to new events or data. Sample Webhook curl command generated: curl -L -X POST -H 'Content-Type: application/json' \ 'https://api-lr.agent.ai/v1/agent/and2o07w2lqhwjnn/webhook/ef2681a0' \ -d '{"user_input":"REPLACE_ME"}' [​](#actions) Actions ------------------------ In the SmartFlow section, users define the steps the agent will perform. Each action is a building block in your workflow, and the order of these actions will determine how the agent operates. Below is a breakdown of the available actions and how you can use them effectively. Actions are grouped in categories, such as: #### [​](#user-input) User Input Capture a wide range of user responses with various input types, from simple text boxes and dropdowns to file uploads and multi-item selectors. For example, prompt users to submit URLs, answer Yes/No questions, or upload documents for review. These actions ensure flexible data collection, enabling interactions that are tailored to different user needs, such as gathering user feedback, survey responses, or receiving important files for processing. #### [​](#get-data) Get Data Access real-time information from a wide range of sources, such as extracting content from web pages, fetching social media data like recent tweets or YouTube videos, and retrieving news articles or Google Calendar events. For example, use these actions to keep users updated with the latest industry news, analyze competitor profiles, or compile social media statistics—providing comprehensive data to power smarter decisions and insights. #### [​](#access-hubspot) Access HubSpot Seamlessly integrate with HubSpot’s CRM to manage, update, or query CRM data directly within workflows. Retrieve contact information, add new companies, update deal properties, or pull HubSpot owners for targeted actions. For example, use this integration to update contact information, assign sales leads, or pull a list of recent deals—enhancing customer relationship management with precise, automated actions. #### [​](#use-ai) Use AI Leverage AI-powered actions to enhance workflows with intelligent outputs, such as generating text, creating images, or synthesizing audio. For instance, use an AI language model to draft content based on user input, generate a product image, or convert text to speech for an audio message. These actions bring cutting-edge AI capabilities directly into workflows, enabling creative automation and smarter outputs. #### [​](#run-process) Run Process Control workflow logic with essential operations like checking conditions, setting variables, or prompting users for confirmation. Use actions such as ‘Set Variable’ to manage dynamic data flows, or ‘If/Else Statement’ to direct users down different paths based on logic outcomes. Whether it’s guiding a user to the next step based on their input or dynamically altering a process, these actions provide robust adaptability for automating complex workflows. #### [​](#create-output) Create Output Deliver meaningful, formatted results that can be communicated or saved for further use. Create engaging outputs like email messages, blog posts, Google Docs, or formatted tables based on workflow data. For example, send users a custom report via email, save generated content as a document, or display a summary table directly on the interface—ensuring results are clear, actionable, and easy to understand. #### [​](#advanced) Advanced Execute specialized, technical tasks that support advanced automation needs. Run serverless functions, invoke Python modules, or make direct web API calls to extend workflows beyond standard capabilities. For instance, fetch data from custom endpoints, process complex calculations using Python, or integrate external services via APIs—enabling deep customization, advanced data handling, and complex integrations. We’ll run through each available action in the Actions page. [​](#sharing) Sharing ------------------------ Here, you define who can use your agent: #### [​](#just-me) Just me Only you can run and see the agent. #### [​](#anyone-with-the-link) Anyone with the link The agent is available to anyone with a direct link to it. #### [​](#specific-users) Specific users Limit access to certain people or teams. #### [​](#public) Public Make the agent public for everyone. [​](#advanced-2) Advanced ---------------------------- Here are a few more advanced options: #### [​](#automatically-generate-sharable-urls) Automatically generate sharable URLs When this setting is enabled, user inputs will automatically be appended to browser urls as new parameters. Users can then share the URL with others, or reload the url themselves to automatically run your agent with those same values. [Welcome](/welcome) [Get User Input](/actions/get_user_input) On this page * [Create Your First Agent](#create-your-first-agent) * [Settings](#settings) * [Required Information](#required-information) * [Optional Information](#optional-information) * [Trigger](#trigger) * [Manual](#manual) * [User configured schedule](#user-configured-schedule) * [Enable agent via email](#enable-agent-via-email) * [HubSpot Contact/Company Added](#hubspot-contact-company-added) * [Webhook](#webhook) * [Actions](#actions) * [User Input](#user-input) * [Get Data](#get-data) * [Access HubSpot](#access-hubspot) * [Use AI](#use-ai) * [Run Process](#run-process) * [Create Output](#create-output) * [Advanced](#advanced) * [Sharing](#sharing) * [Just me](#just-me) * [Anyone with the link](#anyone-with-the-link) * [Specific users](#specific-users) * [Public](#public) * [Advanced](#advanced-2) * [Automatically generate sharable URLs](#automatically-generate-sharable-urls) --- # Get User KBs and Files - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get User KBs and Files [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- The “Get User Knowledge Base and Files” action retrieves information from user-selected knowledge bases and uploaded files to support decision-making within the workflow. ### [​](#use-cases) Use Cases * **Content Search**: Allow users to select a knowledge base to search from. * **Resource Management**: Link workflows to specific user-uploaded files. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#user-prompt) User Prompt * **Description**: Provide a prompt for users to select a knowledge base. * **Example**: “Choose the knowledge base to search from.” * **Required**: Yes ### [​](#required) Required? * **Description**: Mark as required if selecting a knowledge base is essential for the workflow. * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the knowledge base ID. * **Example**: “selected\_kb” or “kb\_source.” * **Validation**: * Only letters, numbers, and underscores (\_) are allowed. * No spaces, special characters, or dashes. * **Regex**: `^[a-zA-Z0-9_]+$` * **Hint**: This variable will be used to reference the knowledge base in subsequent steps. * **Required**: Yes [Get User List](/actions/get_user_list) [Click Go to Continue](/actions/click_go_to_continue) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [User Prompt](#user-prompt) * [Required?](#required) * [Output Variable Name](#output-variable-name) --- # Click Go to Continue - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Click Go to Continue [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#click-go-to-continue) Click Go to Continue ================================================== [​](#overview) Overview -------------------------- The “Click Go to Continue” action adds a button that prompts users to proceed to the next step in the workflow. ### [​](#use-cases) Use Cases * **Workflow Navigation**: Simplify user progression with a clickable button. * **Confirmation**: Add a step for users to confirm their readiness to proceed. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#variable-value) Variable Value * **Description**: Set the display text for the button. * **Example**: “Proceed to Next Step” or “Continue.” * **Required**: Yes [Get User KBs and Files](/actions/get_user_knowledge_base_and_files) [Wait for User Confirmation](/actions/wait_for_user_confirmation) On this page * [Click Go to Continue](#click-go-to-continue) * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Variable Value](#variable-value) --- # Wait for User Confirmation - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Wait for User Confirmation [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- The “Wait for User Confirmation” action pauses the workflow until the user explicitly confirms to proceed. ### [​](#use-cases) Use Cases * **Decision Points**: Pause workflows at critical junctures to confirm user consent. * **Verification**: Ensure users are ready to proceed to the next steps. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#message-to-show-user-optional) Message to Show User (optional) * **Description**: Enter a message to prompt the user for confirmation. * **Example**: “Are you sure you want to proceed?” or “Click OK to continue.” * **Required**: No [Click Go to Continue](/actions/click_go_to_continue) [Get Bluesky Posts](/actions/get_bluesky_posts) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Message to Show User (optional)](#message-to-show-user-optional) --- # Get Data from User's Uploaded Files - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Data from User's Uploaded Files [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve semantic search results from user-uploaded files for targeted information extraction. ### [​](#use-cases) Use Cases * **Data Analysis**: Quickly retrieve insights from reports or project files uploaded by users. * **Customized Searches**: Provide tailored responses by extracting specific data from user-uploaded files. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#query) Query * **Description**: Enter the search query to find relevant information in uploaded files. * **Example**: “Revenue breakdown” or “Budget overview.” * **Required**: Yes ### [​](#user-uploaded-files-to-use) User Uploaded Files to Use * **Description**: Specify which uploaded files to search within. * **Example**: “Recent uploads” or “project\_documents.” * **Required**: Yes ### [​](#max-number-of-document-chunks-to-retrieve) Max Number of Document Chunks to Retrieve * **Description**: Set the maximum number of document chunks to return. * **Example**: “5” or “10.” * **Required**: Yes ### [​](#qualitative-vector-score-cutoff-for-semantic-search-cosine-similarity) Qualitative Vector Score Cutoff for Semantic Search Cosine Similarity * **Description**: Adjust the score threshold for search relevance. * **Example**: “0.2” for broad results or “0.5” for specific results. * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the search results. * **Example**: “file\_search\_results” or “upload\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Data from Builder's Knowledge Base](/actions/get_data_from_builders_knowledgebase) [Get Instagram Followers](/actions/get_instagram_followers) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Query](#query) * [User Uploaded Files to Use](#user-uploaded-files-to-use) * [Max Number of Document Chunks to Retrieve](#max-number-of-document-chunks-to-retrieve) * [Qualitative Vector Score Cutoff for Semantic Search Cosine Similarity](#qualitative-vector-score-cutoff-for-semantic-search-cosine-similarity) * [Output Variable Name](#output-variable-name) --- # Enrich with Breeze Intelligence - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Enrich with Breeze Intelligence [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Gather enriched company data using Breeze Intelligence for deeper analysis and insights. ### [​](#use-cases) Use Cases * **Company Research**: Retrieve detailed information about a specific company for due diligence. * **Sales and Marketing**: Enhance workflows with enriched data for targeted campaigns. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#domain-name) Domain Name * **Description**: Enter the domain of the company to retrieve enriched data. * **Example**: “hubspot.com” or “example.com.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the enriched company data. * **Example**: “company\_info” or “enriched\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Bluesky Posts](/actions/get_bluesky_posts) [Get Data from Builder's Knowledge Base](/actions/get_data_from_builders_knowledgebase) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Domain Name](#domain-name) * [Output Variable Name](#output-variable-name) --- # Get Data from Builder's Knowledge Base - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Data from Builder's Knowledge Base [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch semantic search results from the builder’s knowledge base, enabling you to use structured data for analysis and decision-making. ### [​](#use-cases) Use Cases * **Content Retrieval**: Search for specific information in a structured knowledge base, such as FAQs or product documentation. * **Automated Assistance**: Power AI agents with relevant context from internal resources. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#query) Query * **Description**: Enter the search query to retrieve relevant knowledge base entries. * **Example**: “Latest sales strategies” or “Integration instructions.” * **Required**: Yes ### [​](#builder-knowledge-base-to-use) Builder Knowledge Base to Use * **Description**: Select the knowledge base to search from. * **Example**: “Product Documentation” or “Employee Handbook.” * **Required**: Yes ### [​](#max-number-of-document-chunks-to-retrieve) Max Number of Document Chunks to Retrieve * **Description**: Specify the maximum number of document chunks to return. * **Example**: “5” or “10.” * **Required**: Yes ### [​](#qualitative-vector-score-cutoff-for-semantic-search-cosine-similarity) Qualitative Vector Score Cutoff for Semantic Search Cosine Similarity * **Description**: Set the score threshold for search relevance. * **Example**: “0.2” for broad results or “0.7” for precise matches. * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the search results. * **Example**: “knowledge\_base\_results” or “kb\_entries.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Enrich with Breeze Intelligence](/actions/enrich_with_breeze_intelligence) [Get Data from User's Uploaded Files](/actions/get_data_from_users_uploaded_files) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Query](#query) * [Builder Knowledge Base to Use](#builder-knowledge-base-to-use) * [Max Number of Document Chunks to Retrieve](#max-number-of-document-chunks-to-retrieve) * [Qualitative Vector Score Cutoff for Semantic Search Cosine Similarity](#qualitative-vector-score-cutoff-for-semantic-search-cosine-similarity) * [Output Variable Name](#output-variable-name) --- # YouTube Channel Data - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions YouTube Channel Data [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve detailed information about a YouTube channel, including its videos and statistics. ### [​](#use-cases) Use Cases * **Audience Analysis**: Understand the content and engagement metrics of a channel. * **Competitive Research**: Analyze competitors’ channels. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#youtube-channel-url) YouTube Channel URL * **Description**: Provide the URL of the YouTube channel to analyze. * **Example**: “[https://youtube.com/channel/UC12345](https://youtube.com/channel/UC12345) .” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the channel data. * **Example**: “channel\_data” or “youtube\_info.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Web Page Screenshot](/actions/web_page_screenshot) [YouTube Search Results](/actions/youtube_search_results) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [YouTube Channel URL](#youtube-channel-url) * [Output Variable Name](#output-variable-name) --- # Get Bluesky Posts - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Bluesky Posts [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch recent posts from a specified Bluesky user handle, making it easy to monitor activity on the platform. ### [​](#use-cases) Use Cases * **Social Media Analysis**: Track a user’s recent posts for sentiment analysis or topic extraction. * **Competitor Insights**: Observe recent activity from competitors or key influencers. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#user-handle) User Handle * **Description**: Enter the Bluesky handle to fetch posts from. * **Example**: “jay.bsky.social.” * **Required**: Yes ### [​](#number-of-posts-to-retrieve) Number of Posts to Retrieve * **Description**: Specify how many recent posts to fetch. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the retrieved posts. * **Example**: “recent\_posts” or “bsky\_feed.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Wait for User Confirmation](/actions/wait_for_user_confirmation) [Enrich with Breeze Intelligence](/actions/enrich_with_breeze_intelligence) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [User Handle](#user-handle) * [Number of Posts to Retrieve](#number-of-posts-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Get Instagram Followers - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Instagram Followers [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve a list of top followers from a specified Instagram account for social media analysis. ### [​](#use-cases) Use Cases * **Audience Insights**: Understand the followers of an Instagram account for marketing purposes. * **Engagement Monitoring**: Track influential followers. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#instagram-username) Instagram Username * **Description**: Enter the Instagram username (without @) to fetch followers. * **Example**: “fashionblogger123.” * **Required**: Yes ### [​](#number-of-top-followers) Number of Top Followers * **Description**: Select the number of top followers to retrieve. * **Options**: 10, 20, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the followers data. * **Example**: “instagram\_followers” or “top\_followers.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Data from User's Uploaded Files](/actions/get_data_from_users_uploaded_files) [Get Instagram Profile](/actions/get_instagram_profile) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Instagram Username](#instagram-username) * [Number of Top Followers](#number-of-top-followers) * [Output Variable Name](#output-variable-name) --- # YouTube Search Results - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions YouTube Search Results [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Perform a YouTube search and retrieve results for specified queries. ### [​](#use-cases) Use Cases * **Content Discovery**: Find relevant YouTube videos for research or campaigns. * **Trend Monitoring**: Identify trending videos or topics. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#query) Query * **Description**: Enter search terms for YouTube. * **Example**: “Machine learning tutorials” or “Travel vlogs.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the search results. * **Example**: “youtube\_results” or “video\_list.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [YouTube Channel Data](/actions/youtube_channel_data) [Get HubSpot CRM Object](/actions/get_hubspot_crm_object) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Query](#query) * [Output Variable Name](#output-variable-name) --- # Get HubSpot CRM Object - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get HubSpot CRM Object [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve specific CRM objects like contacts or companies from HubSpot to use in workflows. ### [​](#use-cases) Use Cases * **Customer Insights**: Retrieve detailed information about a contact or company for targeted actions. * **Lead Assignment**: Use CRM data to inform lead distribution. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#object-type) Object Type * **Description**: Select the type of HubSpot object to retrieve. * **Options**: Company, Contact * **Required**: Yes ### [​](#query-optional) Query (optional) * **Description**: Specify search criteria to filter HubSpot objects. * **Example**: “contact email” or “company domain.” * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Provide a variable name to store the HubSpot object. * **Example**: “retrieved\_company” or “contact\_info.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [YouTube Search Results](/actions/youtube_search_results) [Add HubSpot CRM Object](/actions/add_hubspot_crm_object) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Object Type](#object-type) * [Query (optional)](#query-optional) * [Output Variable Name](#output-variable-name) --- # Search Results - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Search Results [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch search results from Google or YouTube for specific queries, providing valuable insights and content. ### [​](#use-cases) Use Cases * **Market Research**: Gather data on trends or competitors. * **Content Discovery**: Find relevant articles or videos for your workflow. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#query) Query * **Description**: Enter search terms to find relevant results. * **Example**: “Best AI tools” or “Marketing strategies.” * **Required**: Yes ### [​](#search-engine) Search Engine * **Description**: Choose the search engine to use for the query. * **Options**: Google, YouTube * **Required**: Yes ### [​](#number-of-results-to-retrieve) Number of Results to Retrieve * **Description**: Specify how many results to fetch. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the search results. * **Example**: “search\_results” or “google\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Search Bluesky Posts](/actions/search_bluesky_posts) [Web Page Content](/actions/web_page_content) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Query](#query) * [Search Engine](#search-engine) * [Number of Results to Retrieve](#number-of-results-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Google News Data - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Google News Data [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch news articles based on queries and date ranges to stay updated on relevant topics or trends. ### [​](#use-cases) Use Cases * **Market Analysis**: Track news articles for industry trends. * **Brand Monitoring**: Stay updated on mentions of your company or competitors. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#query) Query * **Description**: Enter search terms to find news articles. * **Example**: “AI advancements” or “global market trends.” * **Required**: Yes ### [​](#since) Since * **Description**: Select the timeframe for news articles. * **Options**: Last 24 hours, 7 days, 30 days, 90 days * **Required**: Yes ### [​](#location) Location * **Description**: Specify a location to filter news results (optional). * **Example**: “New York” or “London.” * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the news data. * **Example**: “news\_data” or “articles.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Recent Tweets](/actions/get_recent_tweets) [Search Bluesky Posts](/actions/search_bluesky_posts) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Query](#query) * [Since](#since) * [Location](#location) * [Output Variable Name](#output-variable-name) --- # Get Recent Tweets - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Recent Tweets [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch recent tweets from a specified Twitter handle, enabling social media tracking and analysis. ### [​](#use-cases) Use Cases * **Real-time Monitoring**: Track the latest activity from a key influencer or competitor. * **Sentiment Analysis**: Analyze recent tweets for tone and sentiment. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#twitter-handle) Twitter Handle * **Description**: Enter the Twitter handle to fetch tweets from (without the @ symbol). * **Example**: “elonmusk.” * **Required**: Yes ### [​](#number-of-tweets-to-retrieve) Number of Tweets to Retrieve * **Description**: Specify how many recent tweets to fetch. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the retrieved tweets. * **Example**: “recent\_tweets” or “tweet\_feed.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Twitter Users](/actions/get_twitter_users) [Google News Data](/actions/google_news_data) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Twitter Handle](#twitter-handle) * [Number of Tweets to Retrieve](#number-of-tweets-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Get Instagram Profile - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Instagram Profile [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch detailed profile information for a specified Instagram username. ### [​](#use-cases) Use Cases * **Competitor Analysis**: Understand details of an Instagram profile for benchmarking. * **Content Creation**: Identify influencers or collaborators. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#instagram-username) Instagram Username * **Description**: Enter the Instagram username (without @) to fetch profile details. * **Example**: “travelguru.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the profile data. * **Example**: “instagram\_profile” or “profile\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes * * * [Get Instagram Followers](/actions/get_instagram_followers) [Get LinkedIn Activity](/actions/get_linkedin_activity) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Instagram Username](#instagram-username) * [Output Variable Name](#output-variable-name) --- # Get LinkedIn Activity - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get LinkedIn Activity [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve recent LinkedIn posts from specified profiles to analyze professional activity and engagement. ### [​](#use-cases) Use Cases * **Recruitment**: Monitor LinkedIn activity for potential candidates. * **Industry Trends**: Analyze posts for emerging topics. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#linkedin-profile-urls) LinkedIn Profile URLs * **Description**: Enter one or more LinkedIn profile URLs, each on a new line. * **Example**: “[https://linkedin.com/in/janedoe](https://linkedin.com/in/janedoe) .” * **Required**: Yes ### [​](#number-of-posts-to-retrieve) Number of Posts to Retrieve * **Description**: Specify how many recent posts to fetch from each profile. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store LinkedIn activity data. * **Example**: “linkedin\_activity” or “recent\_posts.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Instagram Profile](/actions/get_instagram_profile) [Get LinkedIn Profile](/actions/get_linkedin_profile) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [LinkedIn Profile URLs](#linkedin-profile-urls) * [Number of Posts to Retrieve](#number-of-posts-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Add HubSpot CRM Object - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Add HubSpot CRM Object [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Create a new CRM object, such as a contact or company, directly within HubSpot. ### [​](#use-cases) Use Cases * **Data Entry Automation**: Add new leads or companies during workflows. * **Campaign Management**: Create CRM objects for marketing initiatives. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#object-type) Object Type * **Description**: Select the type of HubSpot object to add. * **Options**: Company, Contact * **Required**: Yes ### [​](#object-properties) Object Properties * **Description**: Enter object properties as key-value pairs, one per line. * **Example**: “name=Acme Corp” or “email=[\[email protected\]](/cdn-cgi/l/email-protection#076d686f6947627f666a776b622964686a) .” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the new HubSpot object. * **Example**: “created\_contact” or “new\_company.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get HubSpot CRM Object](/actions/get_hubspot_crm_object) [Update HubSpot CRM Object](/actions/update_hubspot_crm_object) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Object Type](#object-type) * [Object Properties](#object-properties) * [Output Variable Name](#output-variable-name) --- # Web Page Screenshot - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Web Page Screenshot [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Capture a visual screenshot of a specified web page for documentation or analysis. ### [​](#use-cases) Use Cases * **Archiving**: Save visual records of web pages. * **Presentation**: Use screenshots for reports or presentations. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#url) URL * **Description**: Enter the URL of the web page to capture. * **Example**: “[https://example.com](https://example.com) .” * **Required**: Yes ### [​](#cache-expiration-time) Cache Expiration Time * **Description**: Specify how often to refresh the screenshot. * **Options**: 1 hour, 1 day, 1 week, 1 month * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the screenshot. * **Example**: “web\_screenshot” or “page\_image.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Web Page Content](/actions/web_page_content) [YouTube Channel Data](/actions/youtube_channel_data) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [URL](#url) * [Cache Expiration Time](#cache-expiration-time) * [Output Variable Name](#output-variable-name) --- # Get LinkedIn Profile - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get LinkedIn Profile [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve detailed information from a specified LinkedIn profile for professional insights. ### [​](#use-cases) Use Cases * **Candidate Research**: Gather details about a LinkedIn profile for recruitment. * **Lead Generation**: Analyze profiles for sales and marketing. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#profile-handle) Profile Handle * **Description**: Enter the LinkedIn profile handle to retrieve details. * **Example**: “[https://linkedin.com/in/johndoe](https://linkedin.com/in/johndoe) .” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the LinkedIn profile data. * **Example**: “linkedin\_profile” or “professional\_info.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get LinkedIn Activity](/actions/get_linkedin_activity) [Get Twitter Users](/actions/get_twitter_users) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Profile Handle](#profile-handle) * [Output Variable Name](#output-variable-name) --- # Search Bluesky Posts - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Search Bluesky Posts [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Search for Bluesky posts matching specific keywords or criteria to gather social media insights. ### [​](#use-cases) Use Cases * **Keyword Monitoring**: Track specific terms or hashtags on Bluesky. * **Trend Analysis**: Identify trending topics or content on the platform. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#search-query) Search Query * **Description**: Enter keywords or hashtags to search for relevant Bluesky posts. * **Example**: “#AI” or “climate change.” * **Required**: Yes ### [​](#number-of-posts-to-retrieve) Number of Posts to Retrieve * **Description**: Specify how many posts to fetch. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the search results. * **Example**: “bluesky\_search\_results” or “matching\_posts.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Google News Data](/actions/google_news_data) [Search Results](/actions/search_results) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Search Query](#search-query) * [Number of Posts to Retrieve](#number-of-posts-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Get Twitter Users - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Twitter Users [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Search and retrieve Twitter user profiles based on specific keywords for targeted social media analysis. ### [​](#use-cases) Use Cases * **Influencer Marketing**: Identify key Twitter users for promotional campaigns. * **Competitor Research**: Find relevant profiles in your industry. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#search-keywords) Search Keywords * **Description**: Enter keywords to find relevant Twitter users. * **Example**: “AI experts” or “marketing influencers.” * **Required**: Yes ### [​](#number-of-users-to-retrieve) Number of Users to Retrieve * **Description**: Specify how many user profiles to retrieve. * **Options**: 1, 5, 10, 25, 50, 100 * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the retrieved Twitter users. * **Example**: “twitter\_users” or “social\_media\_profiles.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get LinkedIn Profile](/actions/get_linkedin_profile) [Get Recent Tweets](/actions/get_recent_tweets) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Search Keywords](#search-keywords) * [Number of Users to Retrieve](#number-of-users-to-retrieve) * [Output Variable Name](#output-variable-name) --- # Web Page Content - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Web Page Content [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Extract text content from a specified web page for analysis or use in workflows. ### [​](#use-cases) Use Cases * **Data Extraction**: Retrieve content from web pages for structured analysis. * **Content Review**: Automate the review of online articles or blogs. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#url) URL * **Description**: Enter the URL of the web page to extract content from. * **Example**: “[https://example.com/article](https://example.com/article) .” * **Required**: Yes ### [​](#mode) Mode * **Description**: Choose between scraping a single page or crawling multiple pages. * **Options**: Single Page, Multi-page Crawl * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the extracted content. * **Example**: “web\_content” or “page\_text.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Search Results](/actions/search_results) [Web Page Screenshot](/actions/web_page_screenshot) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [URL](#url) * [Mode](#mode) * [Output Variable Name](#output-variable-name) --- # Get HubSpot Owners - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get HubSpot Owners [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch a list of HubSpot owners to manage assignments or contacts. ### [​](#use-cases) Use Cases * **Team Management**: Assign contacts or deals to specific owners. * **Resource Allocation**: Distribute leads based on available owners. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#output-variable-name) Output Variable Name * **Description**: Provide a variable name to store the list of HubSpot owners. * **Example**: “owners\_list” or “hubspot\_owners.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Update HubSpot CRM Object](/actions/update_hubspot_crm_object) [Get HubSpot Object Properties](/actions/get_hubspot_object_properties) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Output Variable Name](#output-variable-name) --- # If/Else Statement - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions If/Else Statement [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Introduce conditional branching to guide workflows down different paths based on outcomes. ### [​](#use-cases) Use Cases * **Logic-Based Navigation**: Direct users to specific steps based on their inputs or responses. * **Dynamic Processes**: Tailor workflows to handle various scenarios effectively. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#is-else-statement) Is Else Statement? * **Description**: Mark this checkbox if this represents an ‘else if’ or ‘else’ statement linked to previous conditions. * **Required**: No ### [​](#conditional-statement) Conditional Statement * **Description**: Enter the conditional logic that evaluates to true or false. * **Example**: “user\_age > 18” or “order\_total > 100.” * **Required**: No (required for if statements; leave blank for else statements) [Continue or Exit Workflow](/actions/continue_or_exit_workflow) [For Loop](/actions/for_loop) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Is Else Statement?](#is-else-statement) * [Conditional Statement](#conditional-statement) --- # Use GenAI (LLM) - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Use GenAI (LLM) [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Invoke a language model (LLM) to generate text based on input instructions, enabling creative and dynamic text outputs. ### [​](#use-cases) Use Cases * **Content Generation**: Draft blog posts, social media captions, or email templates. * **Summarization**: Generate concise summaries of complex documents. * **Customer Support**: Create personalized responses or FAQs. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#llm-engine) LLM Engine * **Description**: Select the language model to use for generating text. * **Options**: Auto Optimized, GPT-4o, Claude Opus, Gemini 2.0 Flash, and more. * **Example**: “GPT-4o” for detailed responses or “Claude Opus” for creative writing. * **Required**: Yes ### [​](#instructions) Instructions * **Description**: Enter detailed instructions for the language model. * **Example**: “Write a summary of this document” or “Generate a persuasive email.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the generated text. * **Example**: “llm\_output” or “ai\_generated\_text.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get Assigned Company](/actions/get_assigned_company) [Generate Image](/actions/generate_image) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [LLM Engine](#llm-engine) * [Instructions](#instructions) * [Output Variable Name](#output-variable-name) --- # Update HubSpot CRM Object - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Update HubSpot CRM Object [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Modify properties of existing CRM objects, like contacts or companies, within HubSpot. ### [​](#use-cases) Use Cases * **Data Correction**: Update CRM information to ensure accuracy. * **Workflow Automation**: Automatically update deal stages or lead information. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#object-type) Object Type * **Description**: Select the type of HubSpot object to update. * **Options**: Company, Contact * **Required**: Yes ### [​](#object-id) Object ID * **Description**: Enter the ID of the HubSpot object to update. * **Example**: “12345” for a company or “67890” for a contact. * **Required**: Yes ### [​](#property-identifier) Property Identifier * **Description**: Specify the property to update. * **Example**: “name” for company name or “email” for contact email. * **Required**: Yes ### [​](#value) Value * **Description**: Enter the new value for the specified property. * **Example**: “Acme Corp Updated” for a company name or “[\[email protected\]](/cdn-cgi/l/email-protection#bfd5ded1da91dbd0daffdac7ded2cfd3da91dcd0d2) ” for a contact email. * **Required**: Yes [Add HubSpot CRM Object](/actions/add_hubspot_crm_object) [Get HubSpot Owners](/actions/get_hubspot_owners) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Object Type](#object-type) * [Object ID](#object-id) * [Property Identifier](#property-identifier) * [Value](#value) --- # Get HubSpot Object Properties - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get HubSpot Object Properties [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve object properties from HubSpot CRM, such as company or contact details. ### [​](#use-cases) Use Cases * **Data Analysis**: Use property data for insights or decision-making. * **Workflow Automation**: Leverage CRM properties to inform next steps. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#object-type) Object Type * **Description**: Select the type of HubSpot object to retrieve properties from. * **Options**: Companies, Contacts, Deals, Products, Tickets * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the retrieved object properties. * **Example**: “company\_properties” or “contact\_properties.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get HubSpot Owners](/actions/get_hubspot_owners) [Get Assigned Company](/actions/get_assigned_company) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Object Type](#object-type) * [Output Variable Name](#output-variable-name) --- # Get Assigned Company - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Assigned Company [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Fetch the assigned company data from HubSpot for targeted workflows. ### [​](#use-cases) Use Cases * **Lead Management**: Automatically retrieve the assigned company for a contact. * **Reporting**: Use company data for analysis or dashboards. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#output-variable-name) Output Variable Name * **Description**: Provide a variable name to store the assigned company data. * **Example**: “assigned\_company” or “company\_object.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Get HubSpot Object Properties](/actions/get_hubspot_object_properties) [Use GenAI (LLM)](/actions/use_genai) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Output Variable Name](#output-variable-name) --- # Create Blog Post - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Create Blog Post [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Generate a blog post with a title and body, allowing for easy content creation and publishing. ### [​](#use-cases) Use Cases * **Content Marketing**: Draft blog posts for campaigns or updates. * **Knowledge Sharing**: Create posts to share information with your audience. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#title) Title * **Description**: Enter the title of the blog post. * **Example**: “5 Tips for Better Marketing” or “Understanding AI in Business.” * **Required**: Yes ### [​](#body) Body * **Description**: Provide the content for the blog post, including text, headings, and relevant details. * **Example**: “This blog covers the top 5 trends in AI marketing…” * **Required**: Yes [Send Message](/actions/send_message) [Save To Google Doc](/actions/save_to_google_doc) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Title](#title) * [Body](#body) --- # Save To Google Doc - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Save To Google Doc [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Save text content as a Google Doc for documentation, collaboration, or sharing. ### [​](#use-cases) Use Cases * **Documentation**: Save workflow results as structured documents. * **Team Collaboration**: Share generated content via Google Docs. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#title) Title * **Description**: Enter the title of the Google Doc. * **Example**: “Project Plan” or “Meeting Notes.” * **Required**: Yes ### [​](#body) Body * **Description**: Provide the content to be saved in the Google Doc. * **Example**: “This document outlines the key objectives for Q1…” * **Required**: Yes [Create Blog Post](/actions/create_blog_post) [Format Text](/actions/format_text) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Title](#title) * [Body](#body) --- # Set Variable - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Set Variable [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Set or update variables within the workflow to manage dynamic data and enable seamless transitions between steps. ### [​](#use-cases) Use Cases * **Dynamic Data Storage**: Assign user inputs or calculated values to variables for later use. * **Data Management**: Update variables based on workflow logic. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#output-variable-name) Output Variable Name * **Description**: Name the variable to be set or updated. * **Example**: “user\_email” or “order\_status.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes ### [​](#variable-value) Variable Value * **Description**: Enter the value to assign to the variable. * **Example**: “approved” for status updates or “[\[email protected\]](/cdn-cgi/l/email-protection#2f45404741014b404a6f4a574e425f434a014c4042) ” for email storage. * **Required**: Yes [Generate Image](/actions/generate_image) [Add to List](/actions/add_to_list) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Output Variable Name](#output-variable-name) * [Variable Value](#variable-value) --- # Generate Image - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Generate Image [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Create visually engaging images using AI models, with options for style, aspect ratio, and detailed prompts. ### [​](#use-cases) Use Cases * **Creative Design**: Generate digital art, illustrations, or concept visuals. * **Marketing Campaigns**: Produce images for advertisements or social media posts. * **Visualization**: Create representations of ideas or concepts. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#model) Model * **Description**: Select the AI model to generate images. * **Options**: DALL-E 3, Playground v3, FLUX 1.1 Pro, Ideogram. * **Example**: “DALL-E 3” for high-quality digital art. * **Required**: Yes ### [​](#style) Style * **Description**: Choose the style for the generated image. * **Options**: Default, Photo, Digital Art, Illustration, Drawing. * **Example**: “Digital Art” for a creative design. * **Required**: Yes ### [​](#aspect-ratio) Aspect Ratio * **Description**: Set the aspect ratio for the image. * **Options**: 9:16, 1:1, 4:3, 16:9. * **Example**: “16:9” for widescreen formats. * **Required**: Yes ### [​](#prompt) Prompt * **Description**: Enter a prompt to describe the image. * **Example**: “A futuristic cityscape” or “A serene mountain lake at sunset.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Provide a variable name to store the generated image. * **Example**: “generated\_image” or “ai\_image.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes * * * [Use GenAI (LLM)](/actions/use_genai) [Set Variable](/actions/set_variable) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Model](#model) * [Style](#style) * [Aspect Ratio](#aspect-ratio) * [Prompt](#prompt) * [Output Variable Name](#output-variable-name) --- # End If/Else/For Statement - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions End If/Else/For Statement [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Mark the end of a conditional statement or loop to clearly define process boundaries within the workflow. ### [​](#use-cases) Use Cases * **Workflow Clarity**: Ensure conditional branches or loops are properly closed. * **Error Prevention**: Avoid unintended behavior by marking the end of logical constructs. [​](#configuration-fields) Configuration Fields -------------------------------------------------- * **None Required**: This action serves as a boundary marker and does not require additional configuration. [For Loop](/actions/for_loop) [Show User Output](/actions/show_user_output) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) --- # Continue or Exit Workflow - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Continue or Exit Workflow [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Evaluate conditions to decide whether to continue or exit the workflow, providing control over the process flow. ### [​](#use-cases) Use Cases * **Conditional Completion**: End a workflow if certain criteria are met. * **Dynamic Navigation**: Determine the next step in the workflow based on user input or data. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#condition-logic) Condition Logic * **Description**: Define the condition logic using Jinja template syntax. * **Example**: “if user\_age > 18” or “agent\_control = ‘exit’.” * **Required**: Yes [Add to List](/actions/add_to_list) [If/Else Statement](/actions/if_else) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Condition Logic](#condition-logic) --- # Show User Output - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Show User Output [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#show-user-output) Show User Output ========================================== [​](#overview) Overview -------------------------- Display formatted results or data directly to the user in a chosen format such as HTML, JSON, or tables. ### [​](#use-cases) Use Cases * **Real-time Feedback**: Display data summaries or workflow outputs to users. * **Interactive Reports**: Present results in a structured format like tables or markdown. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#heading) Heading * **Description**: Provide a heading for the output display. * **Example**: “User Results” or “Analysis Summary.” * **Required**: No ### [​](#output-formatted) Output Formatted * **Description**: Enter the formatted output in HTML, JSON, or Markdown. * **Example**: “ Results ======= Details go here. ” or “key: value.” * **Required**: Yes ### [​](#format) Format * **Description**: Choose the format for output display. * **Options**: Auto, HTML, JSON, Table, Markdown, Audio, Text, JSX * **Example**: “HTML” for web-based formatting. * **Required**: Yes [End If/Else/For Statement](/actions/end_statement) [Send Message](/actions/send_message) On this page * [Show User Output](#show-user-output) * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Heading](#heading) * [Output Formatted](#output-formatted) * [Format](#format) --- # Send Message - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Send Message [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Send messages to specified recipients, such as emails with formatted content or notifications. ### [​](#use-cases) Use Cases * **Customer Communication**: Notify users about updates or confirmations. * **Team Collaboration**: Share workflow results via email. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#message-type) Message Type * **Description**: Select the type of message to send. * **Options**: Email * **Required**: Yes ### [​](#send-to) Send To * **Description**: Enter the recipient’s address. * **Example**: “[\[email protected\]](/cdn-cgi/l/email-protection#c3a9acabadeda7aca683a6bba2aeb3afa6eda0acae) .” * **Required**: Yes ### [​](#output-formatted) Output Formatted * **Description**: Provide the message content, formatted as needed. * **Example**: “Hello, your order is confirmed!” or formatted HTML for emails. * **Required**: Yes [Show User Output](/actions/show_user_output) [Create Blog Post](/actions/create_blog_post) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Message Type](#message-type) * [Send To](#send-to) * [Output Formatted](#output-formatted) --- # For Loop - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions For Loop [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Iterate over a list or repeat actions a fixed number of times within the workflow. ### [​](#use-cases) Use Cases * **Batch Processing**: Apply the same action to multiple items in a list. * **Iterative Steps**: Execute actions repeatedly based on a defined count. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#list-or-loop-count) List or Loop Count * **Description**: Enter a list to loop over or a fixed number of iterations. * **Example**: ”\[‘A’, ‘B’, ‘C’\]” or “3.” * **Required**: Yes ### [​](#loop-variable-name) Loop Variable Name * **Description**: Name the variable to store the current list item or loop index. * **Example**: “current\_item” or “loop\_index.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes ### [​](#loop-index-variable-name) Loop Index Variable Name * **Description**: Name the variable to store the loop index (starts at 0). * **Example**: “index.” * **Required**: Yes [If/Else Statement](/actions/if_else) [End If/Else/For Statement](/actions/end_statement) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [List or Loop Count](#list-or-loop-count) * [Loop Variable Name](#loop-variable-name) * [Loop Index Variable Name](#loop-index-variable-name) --- # Post to Bluesky - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Post to Bluesky [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Create and post content to Bluesky, allowing for seamless social media updates within workflows. ### [​](#use-cases) Use Cases * **Social Media Automation**: Share updates directly to Bluesky. * **Marketing Campaigns**: Schedule and post campaign content. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#bluesky-username) Bluesky Username * **Description**: Enter your Bluesky username/handle (e.g., username.bsky.social). * **Required**: Yes ### [​](#bluesky-password) Bluesky Password * **Description**: Enter your Bluesky account password. * **Required**: Yes ### [​](#post-content) Post Content * **Description**: Provide the text content for your Bluesky post. * **Example**: “Check out our latest product launch!” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the post result. * **Example**: “post\_response” or “bluesky\_post.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Format Text](/actions/format_text) [Convert File](/actions/convert_file) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Bluesky Username](#bluesky-username) * [Bluesky Password](#bluesky-password) * [Post Content](#post-content) * [Output Variable Name](#output-variable-name) --- # Convert File - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Convert File [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Convert uploaded files to different formats, such as PDF, TXT, or PNG, within workflows. ### [​](#use-cases) Use Cases * **Document Management**: Convert user-uploaded files to preferred formats. * **Data Transformation**: Process files for compatibility with downstream actions. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#input-files) Input Files * **Description**: Select the files to be converted. * **Example**: “uploaded\_documents” or “images.” * **Required**: Yes ### [​](#show-all-conversion-options) Show All Conversion Options * **Description**: Enable to display all available conversion options. * **Required**: Yes ### [​](#convert-to-extension) Convert to Extension * **Description**: Specify the desired output file format. * **Example**: “pdf,” “txt,” or “png.” * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the converted files. * **Example**: “converted\_documents” or “output\_images.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Post to Bluesky](/actions/post_to_bluesky) [Call Serverless Function](/actions/serverless_function) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Input Files](#input-files) * [Show All Conversion Options](#show-all-conversion-options) * [Convert to Extension](#convert-to-extension) * [Output Variable Name](#output-variable-name) --- # Call Serverless Function - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Call Serverless Function [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Run serverless code directly within workflows to execute complex operations or integrate with external systems. ### [​](#use-cases) Use Cases * **Custom Computations**: Perform calculations or processing using serverless logic. * **System Integrations**: Connect with external services or APIs. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#language) Language * **Description**: Select the programming language for the serverless function. * **Options**: Python, Node * **Required**: Yes ### [​](#serverless-code) Serverless Code * **Description**: Enter the serverless function code to execute. * **Example**: Python or Node script performing custom logic. * **Required**: Yes ### [​](#serverless-api-url) Serverless API URL * **Description**: Provide the API URL for the deployed serverless function. * **Required**: Yes (auto-generated upon deployment) ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the result of the serverless function. * **Example**: “function\_result” or “api\_response.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Convert File](/actions/convert_file) [Invoke Web API](/actions/invoke_web_api) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Language](#language) * [Serverless Code](#serverless-code) * [Serverless API URL](#serverless-api-url) * [Output Variable Name](#output-variable-name) --- # Add to List - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Add to List [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Append output values to a list variable for collecting multiple entries or tracking data over time. ### [​](#use-cases) Use Cases * **Data Aggregation**: Collect responses or items into a single list for batch processing. * **Iterative Storage**: Track user selections or action-s over the course of a workflow. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#input-text) Input Text * **Description**: Enter the text to append to the list. * **Example**: “Item A” or “Completed Step 1.” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the updated list. * **Example**: “task\_list” or “user\_choices.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Set Variable](/actions/set_variable) [Continue or Exit Workflow](/actions/continue_or_exit_workflow) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Input Text](#input-text) * [Output Variable Name](#output-variable-name) --- # Invoke Web API - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Invoke Web API [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Make RESTful API calls to external endpoints for data retrieval or updates. ### [​](#use-cases) Use Cases * **Custom Integrations**: Connect workflows with external applications or services. * **Data Retrieval**: Fetch data from custom APIs for use in workflows. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#url) URL * **Description**: Enter the API endpoint URL to connect to. * **Example**: “[https://api.example.com/data](https://api.example.com/data) .” * **Required**: Yes ### [​](#method) Method * **Description**: Select the HTTP method to use. * **Options**: POST, GET, PUT, HEAD * **Required**: Yes ### [​](#headers-json) Headers (JSON) * **Description**: Specify request headers in JSON format. * **Example**: `'{"Authorization": "Bearer token"}'` * **Required**: No ### [​](#body-json) Body (JSON) * **Description**: Enter the request body in JSON format. * **Example**: `{"name": "New Project"}` * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the API response. * **Example**: “api\_response” or “rest\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Call Serverless Function](/actions/serverless_function) [Invoke Other Agent](/actions/invoke_other_agent) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [URL](#url) * [Method](#method) * [Headers (JSON)](#headers-json) * [Body (JSON)](#body-json) * [Output Variable Name](#output-variable-name) --- # Format Text - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Format Text [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Apply formatting to text, such as changing case, removing characters, or truncating, to prepare it for specific uses. ### [​](#use-cases) Use Cases * **Text Standardization**: Convert inputs to a consistent format. * **Data Cleaning**: Remove unwanted characters or HTML from text. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#format-type) Format Type * **Description**: Select the type of formatting to apply. * **Options**: Make Uppercase, Make Lowercase, Capitalize, Remove Characters, Trim Whitespace, Split Text By Delimiter, Join Text By Delimiter, Remove HTML, Truncate * **Example**: “Make Uppercase” for standardizing text. * **Required**: Yes ### [​](#characters-delimiter-truncation-length) Characters/Delimiter/Truncation Length * **Description**: Specify the characters to remove or delimiter to split/join text, or length for truncation. * **Example**: ”@” to remove mentions or “5” for truncation length. * **Required**: No ### [​](#input-text) Input Text * **Description**: Enter the text to format. * **Example**: “Hello, World!” * **Required**: Yes ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the formatted text. * **Example**: “formatted\_text” or “cleaned\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Save To Google Doc](/actions/save_to_google_doc) [Post to Bluesky](/actions/post_to_bluesky) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Format Type](#format-type) * [Characters/Delimiter/Truncation Length](#characters-delimiter-truncation-length) * [Input Text](#input-text) * [Output Variable Name](#output-variable-name) --- # Invoke Other Agent - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Invoke Other Agent [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Trigger another agent to perform additional processing or data handling within workflows. ### [​](#use-cases) Use Cases * **Multi-Agent Workflows**: Delegate tasks to specialized agents. * **Cross-Functionality**: Utilize existing agent capabilities for enhanced results. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#agent-id) Agent ID * **Description**: Enter the ID of the agent to invoke. * **Example**: “agent\_123” or “data\_processor.” * **Required**: Yes ### [​](#parameters) Parameters * **Description**: Specify parameters for the agent as key-value pairs, one per line. * **Example**: “action=update” or “user\_id=567.” * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the agent’s response. * **Example**: “agent\_output” or “result\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Invoke Web API](/actions/invoke_web_api) [Store Variable to Database](/actions/store_variable_to_database) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Agent ID](#agent-id) * [Parameters](#parameters) * [Output Variable Name](#output-variable-name) --- # Get Variable from Database - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Get Variable from Database [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#overview) Overview -------------------------- Retrieve stored variables from the agent’s database for use in workflows. ### [​](#use-cases) Use Cases * **Data Reuse**: Leverage previously stored variables for decision-making. * **Trend Analysis**: Access historical data for analysis. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#variable) Variable * **Description**: Specify the variable to retrieve from the database. * **Example**: “user\_input” or “order\_status.” * **Required**: Yes ### [​](#retrieval-depth) Retrieval Depth * **Description**: Choose how far back to retrieve the data. * **Options**: Most Recent Value, Historical Values * **Example**: “Most Recent Value” for the latest data. * **Required**: Yes ### [​](#historical-data-interval-optional) Historical Data Interval (optional) * **Description**: Define the interval for historical data retrieval. * **Options**: Hour, Day, Week, Month, All Time * **Example**: “Last 7 Days” for weekly data. * **Required**: No ### [​](#number-of-items-to-retrieve-optional) Number of Items to Retrieve (optional) * **Description**: Enter the number of items to retrieve from historical data. * **Example**: “10” to fetch the last 10 entries. * **Required**: No ### [​](#output-variable-name) Output Variable Name * **Description**: Assign a variable name to store the retrieved data. * **Example**: “tracked\_values” or “historical\_data.” * **Validation**: Only letters, numbers, and underscores (\_) are allowed. * **Required**: Yes [Store Variable to Database](/actions/store_variable_to_database) On this page * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Variable](#variable) * [Retrieval Depth](#retrieval-depth) * [Historical Data Interval (optional)](#historical-data-interval-optional) * [Number of Items to Retrieve (optional)](#number-of-items-to-retrieve-optional) * [Output Variable Name](#output-variable-name) --- # Store Variable to Database - Agent.ai Documentation [Agent.ai Documentation home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/light.png)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/agentai/logo/dark.png)](/) Search or ask... Search... Navigation Actions Store Variable to Database [Documentation](/welcome) [Recipes](/recipes/introduction) [API Reference](/api-reference/introduction) [​](#store-variable-to-database) Store Variable to Database ============================================================== [​](#overview) Overview -------------------------- Store variables in the agent’s database for tracking and retrieval in future workflows. ### [​](#use-cases) Use Cases * **Historical Tracking**: Save variables for analysis over time. * **Data Persistence**: Ensure key variables are available across workflows. [​](#configuration-fields) Configuration Fields -------------------------------------------------- ### [​](#variable) Variable * **Description**: Specify the variable to store in the database. * **Example**: “user\_input” or “order\_status.” * **Required**: Yes * * * [Invoke Other Agent](/actions/invoke_other_agent) [Get Variable from Database](/actions/get_variable_from_database) On this page * [Store Variable to Database](#store-variable-to-database) * [Overview](#overview) * [Use Cases](#use-cases) * [Configuration Fields](#configuration-fields) * [Variable](#variable) ---