Skip to content

Opal System Tools Reference

intermediate
📜CoreOpal

System tools are built-in capabilities that Opal uses to take action. When you send a request in Opal Chat, the platform selects the appropriate tools automatically based on your intent. You do not call tools directly. Administrators manage tool availability in Opal > Tools.

You can ask Opal to list available tools with descriptions and parameters at any time.

ToolPurposeKey parameters
browse_webOpen and extract content from multiple URLs concurrently in Markdown or HTMLurls (required), default_information_needed, default_output_format
browse_web_htmlBrowse a single webpage and return raw HTML sourceurl (required)
take_webpage_screenshotCapture a visual screenshot of a webpageurl (required)
ToolPurposeKey parameters
create_canvasCreate an interactive canvas for collaborative editingname, content, mime_type (markdown, html, reactjs, nextjs)
edit_canvasModify existing canvas using JSON Patch operationselement_id, base_commit_id, patch_operations
get_canvasRetrieve canvas content for read-only accesselement_id
get_canvas_by_workspaceList all canvases in the current workspaceNone
get_canvas_workspaceReturn current workspace detailsNone
create_powerpoint_canvasImport .pptx files as interactive canvasname, ppt_url
update_powerpoint_canvasModify PowerPoint canvas contentoperation, plus operation-specific params
ToolPurposeKey parameters
get_todayReturn current UTC date and timeNone
ToolPurposeKey parameters
send_emailCompose and send notification emailsrecipient_emails, subject, body, optional from_email, cc_emails, bcc_emails, attachments
ToolPurposeKey parameters
convert_to_pdfConvert files or webpages to PDFsource (file ID, URL, or webpage URL)
get_file_metadataRetrieve file metadata (dimensions, alt text)file_id
read_file_contentRead files with configurable encodingfile_id, encoding
retrieve_file_from_gcs_uriRead files from Google Cloud Storagegcs_uri, optional mime_type
write_content_to_fileSave generated content as a filecontent, filename, optional content_type
ToolPurposeKey parameters
evaluate_responseQA tool that scores LLM responses 0-100 with feedbackoriginal_prompt, llm_response, optional evaluation_criteria
ideateGenerate plans and suggest tools for complex taskswhat_to_ideate, list_of_tools
reasoning_stepArticulate internal reasoning for multi-step problemsthought_process
ToolPurposeKey parameters
analyze_image_contentInterpret visual content, identify objects and scenesfile_id, query
change_image_aspect_ratioResize images to standard or custom ratiosimage_link, target_aspect_ratio, number_of_images (1-4)
generate_or_edit_imageCreate images from text or edit existing imagesprompt, optional image_links, number_of_images, edit_type

Supported edit types: style_transfer, object_removal, object_addition, background_change, lighting_adjustment, color_correction, artistic_enhancement, aspect_ratio_change.

ToolPurposeKey parameters
figure_out_search_keywordsGenerate 8-15 related search keywordsuser_query
ToolPurposeKey parameters
search_optimizely_docsSearch Optimizely public documentationquery
search_webSearch the web via Googlesearch_query, optional num_results, country_code, exact_terms, file_type, site_search, search_type
ToolPurposeKey parameters
analyze_pagespeedAnalyze performance, SEO, or accessibility via Google PageSpeed Insightsurl, analysis_type (seo_audit, accessibility, page_speed), optional device
ToolPurposeKey parameters
create_todolistCreate a checklist and return its IDoptional initial_item
add_todoAdd items to a checklistlist_id, task_description
complete_todoMark a checklist item completelist_id, task_index
list_todosList all items in a checklistlist_id
ToolPurposeKey parameters
generate_videoGenerate video from text descriptionsprompt, optional starting_image_link, aspect_ratio, duration_seconds (4 or 8), generate_audio, resolution
ToolPurposeKey parameters
search_application_dataSearch CMP campaigns, tasks, and assets with RAGquery, optional chat_history, thread_id
search_optimizely_graphSearch CMP and CMS data via Optimizely Graphquery, optional chat_history, thread_id

Beyond the core tools above, Opal includes product-specific tools that activate when you connect product instances. Each set provides tools tailored to that product’s capabilities.

ProductTool setKey capabilities
CampaignCampaign toolsSmart campaign information retrieval, email management
Configured CommerceCommerce toolsJob step field mapping, commerce operations
CMPCMP toolsCampaign, milestone, task, work request management, asset linking
CMS (SaaS)CMS toolsContent item CRUD, publishing, GEO analysis, SEO, property groups
Content RecommendationsRecs toolsTop content retrieval, topic performance, widget analysis
Feature ExperimentationFX toolsSchema retrieval, template queries, experiment reporting, win rates
Optimizely AnalyticsAnalytics toolsMetric discovery, app listing, data retrieval, dataset search
ODPODP toolsAudience suggestions, creation, listing, configuration retrieval
Optimizely GraphGraph toolsContent structure discovery, GraphQL queries, content search
PersonalizationPersonalization toolsEntity schemas, data fetching, variation development
PIMPIM toolsDashboard statistics retrieval
Product RecommendationsProduct Recs toolsBehavior-based recommendation management
Web ExperimentationWeb Exp toolsVariation development, element management, change validation