Opal System Tools Reference
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.
Browse the web
Section titled “Browse the web”| Tool | Purpose | Key parameters |
|---|---|---|
browse_web | Open and extract content from multiple URLs concurrently in Markdown or HTML | urls (required), default_information_needed, default_output_format |
browse_web_html | Browse a single webpage and return raw HTML source | url (required) |
take_webpage_screenshot | Capture a visual screenshot of a webpage | url (required) |
Canvas
Section titled “Canvas”| Tool | Purpose | Key parameters |
|---|---|---|
create_canvas | Create an interactive canvas for collaborative editing | name, content, mime_type (markdown, html, reactjs, nextjs) |
edit_canvas | Modify existing canvas using JSON Patch operations | element_id, base_commit_id, patch_operations |
get_canvas | Retrieve canvas content for read-only access | element_id |
get_canvas_by_workspace | List all canvases in the current workspace | None |
get_canvas_workspace | Return current workspace details | None |
create_powerpoint_canvas | Import .pptx files as interactive canvas | name, ppt_url |
update_powerpoint_canvas | Modify PowerPoint canvas content | operation, plus operation-specific params |
Date and time
Section titled “Date and time”| Tool | Purpose | Key parameters |
|---|---|---|
get_today | Return current UTC date and time | None |
Email notifications
Section titled “Email notifications”| Tool | Purpose | Key parameters |
|---|---|---|
send_email | Compose and send notification emails | recipient_emails, subject, body, optional from_email, cc_emails, bcc_emails, attachments |
File operations
Section titled “File operations”| Tool | Purpose | Key parameters |
|---|---|---|
convert_to_pdf | Convert files or webpages to PDF | source (file ID, URL, or webpage URL) |
get_file_metadata | Retrieve file metadata (dimensions, alt text) | file_id |
read_file_content | Read files with configurable encoding | file_id, encoding |
retrieve_file_from_gcs_uri | Read files from Google Cloud Storage | gcs_uri, optional mime_type |
write_content_to_file | Save generated content as a file | content, filename, optional content_type |
Ideate and reason
Section titled “Ideate and reason”| Tool | Purpose | Key parameters |
|---|---|---|
evaluate_response | QA tool that scores LLM responses 0-100 with feedback | original_prompt, llm_response, optional evaluation_criteria |
ideate | Generate plans and suggest tools for complex tasks | what_to_ideate, list_of_tools |
reasoning_step | Articulate internal reasoning for multi-step problems | thought_process |
Images
Section titled “Images”| Tool | Purpose | Key parameters |
|---|---|---|
analyze_image_content | Interpret visual content, identify objects and scenes | file_id, query |
change_image_aspect_ratio | Resize images to standard or custom ratios | image_link, target_aspect_ratio, number_of_images (1-4) |
generate_or_edit_image | Create images from text or edit existing images | prompt, 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.
Keywords
Section titled “Keywords”| Tool | Purpose | Key parameters |
|---|---|---|
figure_out_search_keywords | Generate 8-15 related search keywords | user_query |
Search
Section titled “Search”| Tool | Purpose | Key parameters |
|---|---|---|
search_optimizely_docs | Search Optimizely public documentation | query |
search_web | Search the web via Google | search_query, optional num_results, country_code, exact_terms, file_type, site_search, search_type |
Webpage analysis
Section titled “Webpage analysis”| Tool | Purpose | Key parameters |
|---|---|---|
analyze_pagespeed | Analyze performance, SEO, or accessibility via Google PageSpeed Insights | url, analysis_type (seo_audit, accessibility, page_speed), optional device |
To-do lists
Section titled “To-do lists”| Tool | Purpose | Key parameters |
|---|---|---|
create_todolist | Create a checklist and return its ID | optional initial_item |
add_todo | Add items to a checklist | list_id, task_description |
complete_todo | Mark a checklist item complete | list_id, task_index |
list_todos | List all items in a checklist | list_id |
Video (beta)
Section titled “Video (beta)”| Tool | Purpose | Key parameters |
|---|---|---|
generate_video | Generate video from text descriptions | prompt, optional starting_image_link, aspect_ratio, duration_seconds (4 or 8), generate_audio, resolution |
RAG tools (preview)
Section titled “RAG tools (preview)”| Tool | Purpose | Key parameters |
|---|---|---|
search_application_data | Search CMP campaigns, tasks, and assets with RAG | query, optional chat_history, thread_id |
search_optimizely_graph | Search CMP and CMS data via Optimizely Graph | query, optional chat_history, thread_id |
Product-specific tool sets
Section titled “Product-specific tool sets”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.
| Product | Tool set | Key capabilities |
|---|---|---|
| Campaign | Campaign tools | Smart campaign information retrieval, email management |
| Configured Commerce | Commerce tools | Job step field mapping, commerce operations |
| CMP | CMP tools | Campaign, milestone, task, work request management, asset linking |
| CMS (SaaS) | CMS tools | Content item CRUD, publishing, GEO analysis, SEO, property groups |
| Content Recommendations | Recs tools | Top content retrieval, topic performance, widget analysis |
| Feature Experimentation | FX tools | Schema retrieval, template queries, experiment reporting, win rates |
| Optimizely Analytics | Analytics tools | Metric discovery, app listing, data retrieval, dataset search |
| ODP | ODP tools | Audience suggestions, creation, listing, configuration retrieval |
| Optimizely Graph | Graph tools | Content structure discovery, GraphQL queries, content search |
| Personalization | Personalization tools | Entity schemas, data fetching, variation development |
| PIM | PIM tools | Dashboard statistics retrieval |
| Product Recommendations | Product Recs tools | Behavior-based recommendation management |
| Web Experimentation | Web Exp tools | Variation development, element management, change validation |