System tools overview

• When you need to gather information from one or more specific URLs.
• When you want to summarize the content of a webpage.
• When you need to extract raw HTML content from a URL.
• When you are provided with a list of URLs and need to process them.

• urls – A list of URL items. Each item is an object that must contain a url and can optionally contain information_needed to specify what information to extract from that particular URL, and output_format (either 'markdown' or 'raw') to specify the desired output format for that URL.
• default_information_needed – A string representing the default query to use if information_needed is not specified for a particular URL. This parameter is required when the default_output_format is 'markdown'.
• default_output_format – A string specifying the default output format ('markdown' or 'raw') if not specified per URL. 'raw' formats return content without LLM processing.

• Please summarize the main points of the article at https://www.optimizely.com/insights/blog/ and also get the raw content from https://www.example.com.
• Can you tell me what is on this page: https://www.optimizely.com/products/experiment/web/.
• Browse these two links for me: https://www.example.org and https://www.another-example.net.

• When you need the complete, unprocessed HTML source code of a specific webpage.
• When you want to analyze the structure or elements of a page directly.
• When you are not looking for a summary but the full content as rendered by a browser.

• url – The URL of the webpage to browse and return raw content from.

• Get the raw HTML from https://www.optimizely.com.
• I need the full content of this page: https://www.example.com/product-details.
• Can you fetch the HTML source of https://support.optimizely.com/hc/en-us/articles/36354416686477-Optimizely-Opal-overview.

• When you need a visual representation or preview of a webpage.
• When you want to see how a specific URL (including images or PDFs) appears in a browser.
• To get a visual overview of content without needing to browse it yourself.

• url – The URL of the webpage to take a screenshot of.

• Take a screenshot of https://www.optimizely.com.
• Can you show me what https://www.example.com looks like?
• Get a preview of the page at https://www.optimizely.com/blog/latest-posts/.

• Modify specific parts of an existing canvas, whether it is a Markdown document, HTML code, or a React or Next.js application.
• Programmatically update content in a canvas, for example, changing a title, updating a section of text, or replacing a code block.
• Make iterative changes to a canvas's content based on feedback or new requirements.

• element_id – The unique identifier of the canvas (element) you want to modify.
• base_commit_id – A crucial identifier representing the current version of the canvas. It is used to prevent conflicts if multiple people (or the AI) are trying to edit the same canvas simultaneously. When you are editing a canvas in the UI, this ID is typically provided by the system.
• patch_operations – This is a list of instructions (list of dictionaries), in JSON Patch format, that describe the changes you want to make to the canvas content. These operations can include adding, removing, or replacing content, or applying a text-based diff patch.

• Since this tool operates at a technical level with JSON Patch operations, direct user prompts to execute it are less common. Instead, you would typically ask the AI to make a change, and the AI would then use edit_canvas to perform that change. The following are examples of user requests that would likely trigger the AI to use this tool:
• Can you update the main heading in my "Marketing Plan" canvas to "Q4 Marketing Strategy"?
• In my "Product Page" React component, replace the old image URL with https://new-image.com/product.jpg.
• Please remove the third bullet point from the "Key Features" section in my markdown document.
• I want to replace the entire content of my "About Us" page canvas with this new HTML code.

• Create any new editable content, including documents, files, presentations, code, or reports.
• Collaborate on content.
• Generate interactive (runnable) code. 

• name – The name of the canvas (element) to create.
• content – The initial content you want to place in the canvas (element).
• mime_type – The MIME type of the element content which determines how i i's rendered and interpreted. Valid options include the following:
  • text/markdown – For documentation, notes, and articles.
  •  text/html – For pure HTML content.
  • application/x-reactjs – For React components and applications.
  •  application/x-nextjs – For Next.js pages and applications.
• (Optional) space_name – The name for the workspace (space) if you are creating a new one. If you do not provide one, it defaults to the canvas (element) name.
• (Optional) space_description – A description for the workspace (space) if you are creating a new one.

• Create a new markdown document for my marketing brief.
• Write a React component for a hero section.
• Make an HTML page with a simple contact form.
• Can you create a Next.js application for a product listing page?
• I need a canvas to draft a new blog post.

When to use

• Show the current content of a canvas to yourself or others.
• Read the content of a canvas for processing or understanding, such as reviewing a document or code.
• Verify if a canvas exists and retrieve its metadata.
• Any task where you need to see the content but do not intend to modify it.

• element_id – The ID of the canvas (element) you want to retrieve.

• Show me the content of my "Project Proposal" document.
• What is in the canvas named "Homepage Redesign"?
• Can you display the code for the "User Authentication" React component?
• Retrieve the details of ELEMENT_ID.

• See all the content you have created or have access to in the current space.
•  Identify specific canvases before performing actions like retrieving their full content (get_element) or editing them (edit_canvas).
• Check what content already exists. Before creating a new canvas, you might want to see if a similar one already exists.

• None

• List all the canvases in this space.
• What content do I have in my current workspace?
• Show me all the elements I've created.
• Can you give me a summary of all the canvases here?

• Check general information about your current workspace.
• Retrieve metadata associated with the space.
• Verify that a space exists for your current thread.

• None

• What is this workspace about?
• Can you tell me about the current space?
• Show me the details of this project space.

• Use this tool when you want to load an existing .pptx file into an interactive canvas for editing, reviewing, or rewriting slide content.

• name –  The name of the canvas (element) to create.
• ppt_url – Specifies the URL of the .pptx file to import.

• Import this PowerPoint into a new canvas: <URL>.
• Create a canvas from this .pptx so I can rewrite the content.

• Use this tool when you want to edit PowerPoint content already imported into a canvas.

• operation – Indicates the type of PowerPoint update to perform.
• slide_numbers – Lists slides to delete (delete_slide operation).
• search_text – Specifies text to find during replacement.
• replace_text – Specifies text to insert during replacement.
• source_ppt_url – Identifies the external PowerPoint used for copying slides.
• source_slide_number – Selects which slide to copy from the source file.
• image_url – Provides the image to insert into a placeholder.
• slide_number – Selects the slide for image placement or matching.
• placeholder_text_regex – Matches the target placeholder to replace with an image.

• Delete slides 2 and 4 from this presentation.
• Replace all instances of ‘Q3 2024’ with ‘Q4 2024’.
• Copy slide 1 from this external PowerPoint into this canvas.
• Insert this logo into the placeholder labeled ‘Logo’ on slide 3.

• When you need to know the current date and time in UTC.
• When a task or request requires a timestamp or a reference to the current day.

• This tool has no parameters.

• What is today's date?
• Can you tell me the current UTC time?
• What is the date and time right now?

• When you need to send an email to one or more recipients.
• When the email needs to include a subject and a body.
• When you want to include attachments from the Opal backend.
• When you need to CC or BCC other recipients.

• recipient_emails – A comma-separated list of primary recipient email addresses.
• subject – The email subject line.
• body – The email body content (HTML or plain text, auto-detected).
• (Optional) from_email – The sender email address. This can be left blank, and Opal uses a default sender.
• cc_emails – A comma-separated list of CC recipient email addresses.
• bcc_emails – A comma-separated list of BCC recipient email addresses.
• attachments – A comma-separated list of Opal file IDs or file links for attachment.

• Send an email to john.doe@example.com with the subject "Project Update" and the body "The project is on track."
• Please email the marketing team at marketing@optimizely.com about the new campaign, and CC my manager at manager@optimizely.com.
• I need to send a quick note to the sales team, subject "New Product Launch", body "See attached for details", and attach file_id_123 and file_id_456.

• When you need to convert a document (identified by a file ID or URL) into a PDF.
• When you want to save a webpage as a PDF.

• source – The file ID, file URL, or webpage URL to convert to PDF (string). This accepts UUID format file IDs, Opal Backend file links, or any webpage URL.

• Convert the file with ID 'file_12345' to PDF.
• Can you convert the webpage at https://www.optimizely.com/products/web-experimentation/ to a PDF?
• I need a PDF version of this document: https://example.com/report.docx.

• When you have a file ID (from a previous upload or generation) and need to access its associated metadata.
• When you want to confirm details about a file, such as its name, type, or size.

• file_id – The file ID from a previous upload in Opal.

• What is the metadata for file ID 'file_abc123'?
• Can you give me the details of the file with ID '40026099-7bf5-4e36-b5b5-86ffdf4f1de0'?
• Retrieve information about the uploaded document, its ID is 'doc_xyz789'

• When you need to access the textual or binary content of a file that has been previously uploaded to or generated within the Opal Backend.
• When you know the file_id of a file and want to retrieve its content for further processing or display.

• file_id – The file ID from the Opal Backend.
• encoding – The file encoding to use, or 'binary' for binary files.

• Read the content of file 'file_12345'.
• Can you show me what is inside the document with ID 'doc_xyz789'?
• Retrieve the binary content of the image file 'image_id_001'.

• When you need to access the content of a file that is stored in GCS.

• gcs_uri – The GCS URI of the file.
• (Optional) mime_type – The expected MIME type of the file. Should only be provided if you are certain of the MIME type.

• Retrieve the content of the file located at gs://my-bucket/documents/report.pdf.
• Can you get the data from this GCS URI: gs://data-lake/analytics/sales_data.csv?
• Fetch the image from gs://product-images/new_product.png.

• When you need to save any generated content (text, code, markdown) as a file.
• To store temporary or permanent content that might be used by other tools (for example, as an attachment for an email).

• content – The content to write to the file.
• filename – The desired filename with its extension (for example, "document.pdf" or "image.png").
• (Optional) content_type – The MIME type of the content, auto-detected if not provided.

• Save this markdown content as "my_report.md".
• Write the following HTML code to a file named "index.html".
• Create a text file called "meeting_notes.txt" with the content "Discussed Q4 strategy and next steps."

• When you need to verify if your generated answer meets expected format and quality standards before finalizing your response.
• To get objective feedback on an LLM's output against a given prompt and criteria.

• original_prompt – The original prompt or question that you asked the LLM.
• llm_response – The LLM's response that needs to be evaluated for quality and format.
• (Optional) evaluation_criteria – Specific criteria to focus on during evaluation.

• Evaluate my response to the user's request for a campaign brief.
• Check if this generated code adheres to the specified formatting guidelines.
• Assess the quality of my explanation for the browse_web tool based on the original prompt.

• When you are unsure how to proceed with a complex request or problem.
• When you want a strategic plan or a step-by-step approach to address a query.
• When you need to break down a large problem into smaller, manageable steps.
• When you want to explore different ways to use the available tools to achieve a goal.

• what_to_ideate – The topic or problem to ideate on. This should be a clear description of what you want to brainstorm or plan for.
• list_of_tools – A list of tools that can be suggested during the ideation process. This helps the ideation process focus on practical applications of the available functionalities.

• Ideate on how to create a new marketing campaign using the available tools.
• I need a plan to analyze website performance and suggest improvements.
• How can I use the tools to generate customer segments and then create targeted content.

• Whenever Opal needs to think through a complex problem or user request.
• To break down a multi-step task into a clear plan.
• To analyze the user's query and determine the best approach using available tools.
• To record my internal observations or decisions before generating a response.

• thought_process – where Opal articulate its detailed internal reasoning, step-by-step plan, analysis of the query, or any scratchpad notes needed to arrive at the final answer.

• I need to determine the best sequence of tool calls to fulfill this request.
• Let me analyze your intent and identify any ambiguities.
• My plan is to first search for relevant information, then synthesize it, and finally present it to the user.

• Describe what is present in an image.
• Identify objects, people, or scenes within a picture.
• Answer specific questions about the visual information in an image.
• Extract context or details from a screenshot or any other image.

• file_id – The ID of the image file you want me to analyze. This would typically be an ID you received from Opal after uploading an image or if Opal generated an image for you.
• query – The question or analysis request you have about the image.

• What is in this image?
• Describe the main elements of this screenshot.
• What is the person in this image doing?
• Can you tell me about the product shown in this picture?

• When you need to change the aspect ratio of an existing image.
• When you want to adapt an image to a specific display size or layout requirement (for examplee, for a social media post, website banner, or print).
• When you explicitly request to "change the aspect ratio," "make it square," "widescreen," or similar.

• image_link – A single image file link to change the aspect ratio.
• target_aspect_ratio – The desired target aspect ratio. Options include standard ratios like '1:1' (Square), '4:3' (Standard landscape), '16:9' (Widescreen landscape), '9:16' (Vertical portrait), or custom ratios such as '3:2', '21:9', '5:4', and so on.
• number_of_images – The number of variations (integer, from 1 to 4) to generate for the new aspect ratio.

• Change the aspect ratio of this image to 16:9.
• Can you make this picture a square?
• I need to resize this image to a 9:16 portrait format.
• Adjust the aspect ratio of the image at 'link_to_image.jpg' to 3:2.

• When you need to generate a new image based on a textual description.
• When you want to edit an existing image, such as removing an object, changing the background, or adjusting lighting.
• When you want to create multiple variations of an existing image.
• When performing operations like style transfer, object addition, or artistic enhancement on an image

• prompt – A text description for image generation or detailed instructions for image modification.
• image_links – A comma-separated string of image file links. This can be used for editing existing images or generating variations. The first image is considered primary, and additional images provide context.
• number_of_images – The number of variations (integer, 1-4) to generate or edit.
• edit_type – The type of edit operation for temperature optimization (edit mode only). Options include the following:
  • style_transfer
  • object_removal
  • object_addition
  • background_change
  • lighting_adjustment
  • color_correction
  • artistic_enhancement
  • aspect_ratio_change
• historical_context – Previous conversation context or editing history (edit mode only).

• Generate a picture of a futuristic city at sunset.
• Edit this image to remove the person in the background.
• Change the style of this photo to a watercolor painting.
• Create three variations of this product image with different lighting.
• Add a dog to the image at 'image_link_1'.

• When you need to determine effective keywords for a search based on a user's natural language query.
• When you want to understand the core components of a  request to formulate precise search queries for other tools (like search_web or search_optimizely_docs).
• To break down a complex query into actionable search terms.

• user_query – The query for which the search keywords need to be generated.

• Figure out search keywords for "Optimizely product features and benefits".
• What are the best keywords to search for information on "A/B testing best practices"?
• Help me find search terms for "How to integrate Optimizely with Google Analytics".

• Understand how to perform a specific task within an Optimizely product.
• Search the Optimizely knowledge base or documentation for answers to your questions.
• Find steps, procedures, or details about product features that are likely covered in support documentation.
• Clarify or supplement your understanding of a topic if you are unsure about an answer.

• query – The search query you want to use to find information in the Optimizely knowledge base.

• How do I create a new experiment in Optimizely Web Experimentation?
• Tell me about the different types of content in Optimizely CMS.
• What are the steps to integrate Optimizely Feature Experimentation with a React application?
• Search the documentation for information on A/B testing best practices.
• I need to know how to set up metrics in Personalization.

• Find general information, news, or external resources related to marketing, experimentation, or digital experience.
• Look for best practices, industry trends, or competitive analysis that extends beyond Optimizely's product features.
• Search for images or other media files.
• Gather information from specific websites (site search).
• Find definitions or explanations of general concepts.

• search_query – The main query you want to search for.
• (Optional) num_results – The number (integer) of search results you want to retrieve.
• (Optional) country_code – A two-letter ISO country code (for example, 'us' or 'gb') to localize your search results.
• (Optional) exact_terms – A phrase that all documents in the search results must contain.
• (Optional) exclude_terms – A word or phrase that must not appear in the search results.
• (Optional) file_type – If you are looking for specific file formats (for example, 'pdf' or 'docx').
• (Optional )site_search – Specifies a particular website to include or exclude from the search results (for example, 'optimizely.com').
• (Optional) search_type – Set to 'image' if you are looking for images.
  • (Optional) image_size – If search_type is 'image', you can specify the desired image size (for example, 'large', 'medium', or 'icon').
  • (Optional) image_type – If search_type is 'image', you can specify the desired image type (for example, 'photo', 'clipart', or 'face').

• What are the latest trends in e-commerce personalization?
• Find articles about A/B testing strategies.
• Search for images of successful landing page designs.
• What is the definition of 'customer lifetime value'?
• Find information on optimizely.com about feature flags.
• Search for marketing automation tools, excluding HubSpot.

• Before launching a new webpage or website, to ensure it meets performance, SEO, and accessibility standards.
• When a webpage is experiencing slow loading times, high bounce rates, or poor user engagement, to identify underlying technical issues.
• To regularly check and improve the accessibility of a website, ensuring it is usable by individuals with disabilities.
• To identify technical SEO opportunities and issues that might be impacting search engine rankings.
• After implementing performance or SEO improvements, to verify their effectiveness and measure the impact.

• url – The URL of the webpage to analyze.
• analysis_type – The type of audit to perform. It can be one of the following:
  • 'seo_audit' – Technical SEO analysis with performance metrics (SEO + Performance categories).
  • 'accessibility' – Accessibility audit (WCAG/ARIA compliance).
  • 'page_speed' – Page speed and performance analysis (Performance + Best Practices categories).
• (Optional) device – The device to emulate for the analysis. It can be 'desktop' or 'mobile'.

• Can you run a page speed analysis for https://www.optimizely.com on mobile?
• I need an SEO audit for my new product page at https://www.example.com/products/new-product.
• Check the accessibility of our homepage https://www.mycompany.com.
• Give me a performance report for https://blog.optimizely.com on desktop.
• Perform an SEO and performance audit for https://www.marketingcampaign.com/landing-landing-landing-landing.page.

• Find specific campaigns, tasks, or assets in CMP.
• Get information about campaign briefs or task details.
• Search for content across your CMP workspace.
• Retrieve context for content creation or planning.

• query – Search query to find relevant application data in CMP.
• (Optional) chat_history – Previous conversation context for better search results.
• (Optional) thread_id – Thread identifier for conversation continuity.

• Find campaigns related to summer marketing.
• Show me tasks assigned to the design team.
• What assets do we have for product launches?
• Find campaign briefs about social media.

• Search for content across your Optimizely products (CMS, CMP).
• Find specific content, such as articles, products, or experiments.
• Get analytics or summary data from Optimizely Graph.
• Power headless content delivery for mobile or web applications.

• query – Search query to find relevant application data in CMP or CMS.
• (Optional) chat_history – Previous conversation context for better search results.
• (Optional) thread_id – Thread identifier for conversation continuity.

• Find content related to 'winter promotions'.
• Show me analytics for the latest homepage experiment.
• What features are enabled for US users?

• Add a new task or item to a specific to-do list.
• Keep track of action items or reminders related to your Optimizely projects or general work.

• list_id – The ID of the to-do list where you want to add the task.
• task_description – A description of the task you want to add.

• Add "review campaign brief" to my to-do list.
• Can you add "follow up with design team" to my tasks?
• I need to add "prepare Q4 report" to my list.

• Mark a specific task on your to-do list as completed.
• Remove a task from your list when it is finished.

• list_id – The ID of the to-do list from which you want to complete a task.
• task_index – The index (0-based) of the task you want to complete within the specified list.

• Mark "review campaign brief" as complete.
• I finished "follow up with design team", please complete it.
• Complete the task "prepare Q4 report".
• I am done with the first item on my list. In this case, you would need to specify the task_index.

• Start a new list to organize tasks, action items, or reminders.
• Create a dedicated list for a specific project, campaign, or area of work.

• (Optional) initial_item –The description of the first task to add to the newly created to-do list.

• Create a new to-do list for my marketing campaign tasks.
• Make a new list called "Website Redesign Checklist".
• Create a to-do list and add "research competitor websites" as the first item.

• See all the tasks that are currently on a particular to-do list.
• Check the progress or status of items in a list.
• Get an overview of what needs to be done for a project or initiative.

• list_id –The ID of the to-do list you want to view.

• List all my tasks.
• Show me what's on my "Marketing Campaign" to-do list.
• What are the outstanding items in the "Website Redesign" list?

• Create a new video based on a textual description.
• Generate a video using an existing image as a starting point.
• Produce video content for marketing, social media, or other digital experiences.
• Experiment with different video styles, durations, or aspect ratios.

• prompt – A text description of the video you want to generate.
• (Optional) starting_image_link – The URL or link to a starting image to be used for image-to-video generation.
• (Optional aspect_ratio – The aspect ratio of the video. Options include '16:9' (Widescreen), '9:16' (Portrait), or '1:1' (Square). If not specified, it defaults to '16:9'.
• (Optional) duration_seconds – The desired duration of the video in seconds. Options are 4 or 8. If not specified, it defaults to 8 seconds.
• (Optional) generate_audio – Set to True to include audio generation in the video. If not specified, it defaults to True.
• (Optional) generation_mode – Determines the balance between generation speed and quality. Options are 'standard' or 'fast'. If not specified, it defaults to 'standard'.
• (Optional) number_of_videos – The number of video variations to generate. You can request 1 or 2 variations. If not specified, it defaults to 1.
• (Optional) resolution – The resolution of the video. Options are '1080p' or '720p'. If not specified, it defaults to '1080p'.

• Generate a video of a futuristic city at sunset.
• Create a 16:9 video, 8 seconds long, showing a product being unboxed.
• Generate a video from this image: https://example.com/image.jpg with a prompt about a serene forest.
• Make a short portrait video (9:16) of a person dancing.
• Generate two variations of a video about a new software feature.