System tools for Content Marketing Platform (CMP)

34 min

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Optimizely Content Marketing Platform (CMP)Optimizely Content Marketing Platform (CMP) includes a set of system tools designed to support content planning and production. These Opal system tools are grouped by functionality to make it easier to find the right tool for your workflow.

Note

Ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts for calling the tool. If you do not provide a required parameter, Opal prompts you for it.

Create

Collaborate

Get

File operations

Idea Lab

The Idea Lab tools are available for CMS (SaaS) and Content Marketing Platform (CMP).

Retrieve

Search

Suggest

Update

When to use

Modify the values of existing fields on a content asset within a task.

Add new fields to a content asset within a task.

This is typically the final step in a field management workflow:

First, you might use get_all_fields to find available fields.

Then, you would use get_task_asset_fields to retrieve the current fields on the asset.

Next, you would merge the existing fields with any new fields you want to add or update.

Finally, you use update_task_asset_fields to apply this complete, merged list of fields.

Parameters

task_id – The ID of the task containing the asset. You can often find this in the current URL or it might be provided by you.

asset_id – The ID of the asset or content item within the task that you want to update. This is a critical parameter, and typos result sin errors. For newly created content, there might be a short delay before it os ready for field updates.

fields (list of objects) – A complete list of field objects that will replace all existing fields on the asset. Each field object must include the following:

id – The ID of the field (obtained from get_all_fields).

type – The type of the field (for example, 'text', 'dropdown', or 'label').

values (list): A list of values for the field. The format depends on the field type.

text, text_area, or rich_text – ['text_value'].

dropdown or radio_button – ['choice_id_string'] (use the choice ID from the field definition).

checkbox or label – ['choice_id_string', 'another_choice_id'] (use choice IDs as strings).

date – ['2024-12-31T23:59:59Z'] (ISO datetime string).

simple_number, currency_number, or percentage_number – [123] (numeric value)

For new fields, you can use an empty list [] to add the field without specific values initially.

Example prompts

Since this tool requires a structured list of all fields, direct natural language prompts are less common. Instead, you would typically describe the change you want, and Opal constructs the necessary field list.

Add a "Priority" label with a value of "High" to the article in task task-123.

Update the "Publish Date" for the image asset in task task-456 to 2025-12-31.

Set the "Status" dropdown for the content in task task-789 to "Approved".

I want to add a checkbox field called "Featured" and mark it as true for the video asset in task task-001.

When to use

Add a new custom field to a task (for instance, a "Budget" field or a "Project Manager" field).

Update the value of an existing field on a task (for example, change the "Status" from "Draft" to "In Review" or update a "Due Date").

Simplify field management by referring to fields by name rather than complex IDs.

Parameters

task_id – The unique identifier of the task you want to modify.

field_name – The name of the field you want to update or create (case-insensitive matching for existing fields).

field_type (Required for new fields, optional for updates) – The type of the field. This is necessary if you are creating a new field. If you are updating an existing field, this parameter is ignored. Supported types include the following:

text

text_area

rich_text

simple_number

currency_number

percentage_number

date

checkbox

label

dropdown

radio_butto

image

video

values – The values for the field. The format of this parameter depends on the field_type.

Text fields (text, text_area, rich_text) – A single string value in an array (for example, ["Your text here"]).

Numeric fields (simple_number, currency_number, percentage_number) – A single numeric value in an array (for instance, [5000]).

Date fields (date) – A single ISO 8601 UTC datetime string in an array (for example, ["2025-12-31T23:59:59Z"]).

Selection fields (checkbox, label) – An array of choice IDs for multiple selections (for instance, ["tag_id_1", "tag_id_2"]).

Selection fields (dropdown) – An array of choice IDs (single for non-multi-select dropdowns) (for instance, ["choice_id_1"]).

Selection fields (radio_button) – A single choice ID in an array (for example, ["choice_id_1"]).

Asset fields (image, video) – A single asset object with title and key properties (for example, [{ "title": "My Image", "key": "asset_key_123" }]).

Example prompts

Set the 'Priority' field on task task-123 to 'High'.

Add a 'Budget' field to task task-456 with a value of 5000.

Update the 'Due Date' for task task-789 to 2025-12-31T23:59:59Z.

Create a 'Tags' field on task task-001 and set its values to 'Marketing' and 'Campaign'.

Change the 'Content Type' field on task task-555 to 'Blog Post'.

Note

If you use Opti ID, administrators can turn off generative AI in the Opti ID Admin Center. See Turn generative AI off across Optimizely applicationsTurn generative AI off across Optimizely applications.

System tools for Content Marketing Platform (CMP)

Create

create_article_in_task – Creates an article inside a task in CMP.

create_campaign – Proposes new campaigns for CMP based on the prompt, conversation history, and existing campaign brief (if creating a sub-campaign).

create_campaign_from_work_request – Creates a campaign in Opal based on an existing work request.

create_event – Creates an event in CMP to track important dates and activities.

create_library_folder – Creates a folder in the CMP library to organize assets and content. Folders support nesting by specifying a parent folder ID.

create_milestone – Creates a new milestone within a specified campaign or project in CMP.

create_task – Creates a single task suggestion for a specified CMP campaign.

create_tasks – Suggests multiple tasks for a CMP campaign based on prompt, chat history, and campaign brief.

create_task_from_work_request – Creates a new task in CMP based on an existing work request.

create_work_request – Create a new work request in CMP using a specified template.

Collaborate

add_comment_on_cmp_campaign – Add a comment to a CMP campaign, with support for attachments and replies.

add_comment_on_cmp_task – Add a comment to a CMP task, with support for attachments and replies.

add_comment_on_task_substep – Add a comment to a CMP task workflow substep.

add_comment_on_cmp_work_request– Add a comment with optional file attachments to a work request in CMP.

add_field_to_asset – Add a custom field and its value to an existing asset in the content library.

update_work_request – Update a work request in CMP by modifying its assignee, status, or priority.

Get

get_all_fields – Returns suggested task-asset fields in CMP that match a natural-language description. Includes IDs, names, types, and descriptions.

get_cmp_content_type_details – Returns details for a specific content type in CMP.

get_cmp_organization_content_types – Lists content types defined for your organization in CMP.

get_cmp_resource – Returns contextual information for a CMP task or campaign, including content and file metadata.

get_cmp_resource_files – Fetches files (images, videos, raw files, and attachments) from CMP tasks or campaigns and uploads them into Opal.

get_form_templates – Retrieves a list of all available form templates in CMP.

get_form_template_by_id – Retrieves a specific form template using its unique identifier.

get_library_folder_tree – Displays a hierarchical tree view of the CMP library folders and assets. Functions much like the tree command in Unix, displaying folders and assets in a tree-like format.

get_object_templates – Retrieves a list of available object templates in CMP.

get_relevant_workflows – Finds CMP workflows that match the given context.

get_saved_view_resources – Retrieves resources associated with a specific saved view in CMP.

get_task_asset_fields – Retrieves current field values for a task asset.

get_workflow_by_id – Returns the CMP workflow's structure, steps, sub-steps, actions, and assignees.

File operations

batch_upload_files_to_cmp_resource – Uploads multiple files to a CMP campaign, task, or library.

write_file_to_library – Write (create or update) a file to the CMP Library with automatic folder creation and file versioning.

Idea Lab

get_idealab_domain_competition – Returns Idea Lab domain organic competition data.

get_idealab_domain_keywords– Returns Idea Lab domain organic competition data.

get_idealab_keyword_infos – Returns Idea Lab SEO keyword information.

get_idealab_keyword_keyword_questions – Returns common questions for an Idea Lab SEO keyword in a given country. This is highly valuable for content creation, FAQ development, and understanding user intent.

get_idealab_keyword_related_keywords – Returns related keywords that are semantically related to a given keyword in a specific country. This helps in expanding keyword research and discovering new content opportunities.

Retrieve

retrieve_from_cmp – Retrieves content items from CMP.

retrieve_from_cmp_as_csv – Retrieves content items from CMP and exports them as a .csv file.

Search

find_library_folder – Finds CMP library folders using regex.

find_team – Finds CMP teams using regex-based queries.

find_user – Finds CMP users using regex-based queries. This is useful for identifying individuals based on their name, role, or other attributes.

search_cmp_resources – Searches for various resources within CMP based on specified criteria.

Suggest

suggest_structured_content – Suggests structured content, such as articles, blogs, newsletters, or social media posts, for a CMP task. This is useful for populating tasks with initial content drafts based on a summary and desired content type.

Update

canvas_to_structured_content – Converts the content of an AI canvas into a specified structured content (an asset type) within a specified CMP task.

update_asset – Updates various properties of an asset in the CMP Library, including metadata, tags, location, and archival status, using partial updates.

update_campaign_brief – Updates a campaign brief in CMP after you give Opal a confirmation.

update_library_asset_field – Updates a single field value on a CMP library asset, supporting various CMP field types and value formats.

update_milestone – Modifies the details of an existing CMP milestone, such as its name, due date, status, or description.

update_task – Updates an existing task's title, owner, dates, or other attributes.

update_task_asset_fields – Adds or replaces fields on a CMP task's asset or content. This tool completely replaces all existing fields on the asset, so you need to include all fields you want to keep, plus any new ones.

update_task_brief – Updates the brief for a task in CMP.

upsert_task_field – Creates or updates a CMP task field by name.

update_task_structured_content – Updates structured content within a CMP task.

update_task_substep – Update the status or assignee of workflow substeps in a task by matching step names (supports complete, progress, skip, and assign).

update_work_request_resource_link – Modifies an existing resource link associated with a specific work request, such as updating its URL, description, or type.