Uncountable MCP Tool Reference

This article lists every tool the Uncountable MCP server offers to connected AI clients, with each tool’s arguments. For connection steps, see Uncountable MCP Setup Guide.

The server offers 100 tools: 37 read only and 63 that modify data. Every tool call runs with the connected user’s account and permissions, so a tool can only read or change what that user can access in Uncountable.

💡 Controlling which tools are available: Admins can turn off individual tools, or turn on Read Only Access to offer clients only the read only tools. See the Configuring tools section of the Uncountable MCP Setup Guide.

Tool labels

Each tool is labeled with one or more of the following:

Many read tools return results in pages. When a result includes nextCursor, pass it as cursor to read the next page.

Read only tools

Convert Chemical Formats

convert_chemical_formats · Read Only

Convert chemical structure strings (MOL v2000, MOL v3000, or SMILES formats) into the Uncountable internal format for use with other APIs such as set_input_attribute_values.

Describe Entity Definition

describe_entity_definition · Read Only

Explains what the entities of one entity definition hold: lists each field with its ref name, label, value type, allowed options, and what its ids refer to. Call it before you read, filter, or write the entities of an entity definition. Pass the entityType and definitionId from list_entity_definitions. A field that holds field options lists up to 40 of them. When a field has references, pass them as spec to match_id_source or list_id_source to resolve the ids that the field holds. It also lists the phases that an entity moves through, with the phase ids that transition_entity_phase takes. It ends with howTo, which names the calls that find, list, read, create, update, and move these entities.

Find Custom Entity Definition

find_custom_entity_definition · Read Only

Finds which custom entity definition a name that the user mentions refers to, by matching the label or ref name of each permitted, non-archived definition. Use the returned definitionId with listing_discover_columns and listing_run_query for an entity_type=custom_entity query. Pass nameContains to match a label or ref name. Results are ordered by label and paged. Pass nextCursor as cursor to read the next page.

Get Analyze Results

get_analyze_results · Read Only

Returns how well a completed job’s models reproduce the outputs they were trained on, and how much each input influences each output. Accepts analyze and suggest jobs, since both train models. Fails if the job has not completed successfully. Requires an ML training license.

Get Column Calculation Values

get_column_calculation_values · Read Only

Retrieves the computed values for a single column calculation across multiple recipes. Returns the calculation quantity for each recipe, along with the associated recipe step, recipe input, and ingredient IDs.

Get Current User Info

get_current_user_info · Read Only

Returns the user ID of the currently authenticated user. Requires a valid authenticated session. Takes no arguments.

Get Curve

get_curve · Read Only

Returns the x and y curve data for a recipe output or recipe input. Exactly one target (output or input) must be specified. Returns the curve values sorted by index.

Get Entities Data

get_entities_data · Read Only

Retrieves field values for entities of the same type. All requested entities must share the same entity type.

Get Input Data

get_input_data · Read Only

Returns detailed metadata for inputs (ingredients and/or process parameters) in a material family, including attribute values, global category assignments, and subcategory (tag) assignments. Can filter by specific input IDs or by type (ingredient vs parameter). Excludes archived inputs. Paginated with a default and maximum limit of 1,000 results, ordered by input ID.

Get Input Group Names

get_input_group_names · Read Only

Returns the ID and name of all input groups in a material family that are either owned by the requesting user or shared globally (no owner). Results are ordered by input group ID.

Get Input Names

get_input_names · Read Only

Returns the ID and name of all non-archived inputs (ingredients and/or process parameters) in a material family. Can filter by type (ingredient vs parameter) using is_parameter. Paginated with a default and maximum limit of 20,000 results, ordered by input ID.

Get Inputs Data

get_inputs_data · Read Only

Returns detailed metadata for a list of inputs by their IDs, including attribute values, categories per material family, and subcategory tags. Also returns attribute definitions (name and quantity type) for all referenced attributes.

Get Notebook Content

get_notebook_content · Read Only

Retrieves the structured content of a notebook by identifier key. Only exportable cell types are included: HTML text, tables (with text or image cells and optional styling), chemical structures (MOL 3000 or RXN 3000 format), equations, files, images, and reaction tables. Non-exportable cell types (charts, graphs, dashboards) and cells marked as excluded from export are omitted. Chemical structures that fail to convert are returned as chemical_structure_error entries with an error message. File and image entries include a key for each file.

Get Output Data

get_output_data · Read Only

Returns detailed metadata for outputs in a material family, including quantity type, global category assignments, and associated units. Can filter by specific output IDs. Excludes archived outputs. Paginated with a default and maximum limit of 1,000 results, ordered by output ID. Also returns referenced global category and unit definitions.

Get Output Names

get_output_names · Read Only

Returns the ID and name of all non-archived outputs in a material family. Outputs represent measurement values of any type (numeric, text, curve, calculation, etc.). Paginated with a default and maximum limit of 20,000 results, ordered by output ID.

Get Output Organization

get_output_organization · Read Only

Returns the output organization configuration (column and table definitions) for a given scope: material family, project, or user. Organization parameters define how outputs are grouped and sorted, and can be based on category, recipe input, or condition parameter.

Get Projects

get_projects · Read Only

Lists non-archived projects the user has permission to access, optionally filtered by material family ID. Requires either allMaterialFamilies=true or a specific materialFamilyId; returns 400 if neither is set. Returns projects ordered by ID along with their associated phase definitions. Projects represent groupings of experiments, similar to folders in a directory structure.

Get Projects Data

get_projects_data · Read Only

Retrieves detailed data for a set of projects, including field values, phase definitions, and field metadata. Paginated to limit response size.

Get Recipe Calculations

get_recipe_calculations · Read Only

Retrieves calculation values for the specified recipes. When specific calculations are requested, they are computed on-the-fly. Otherwise, not all calculations may be returned. Returns both the per-recipe calculation values and the calculation definitions.

Get Recipe Links

get_recipe_links · Read Only

Retrieves links between recipes, traversing up to the specified depth with a maximum depth of 20. Only returns immediate links at each traversal level. Optionally filters by link type. Results are limited to 500 links total; fails if this limit is exceeded.

Get Recipe Metadata Data

get_recipe_metadata_data · Read Only

Retrieves recipe metadata field definitions for a material family. Recipe metadata represents data associated with experiments that is not an input, output, or calculation (e.g. sample ID, location). Results are paginated with a default and maximum limit of 1000, ordered by metadata field ID. Optionally filters to specific metadata IDs.

Get Recipe Names

get_recipe_names · Read Only

Returns the ID and name of all non-archived recipes in the specified project, ordered by recipe ID. Archived recipes are excluded from the results.

Get Recipe Output Metadata

get_recipe_output_metadata · Read Only

Retrieves metadata values and their field definitions for the specified recipe outputs. Accepts at most 500 recipe output IDs. Returns metadata values (numeric or JSON) along with the non-archived metadata field definitions.

Get Recipes Data

get_recipes_data · Read Only

Retrieves data for the requested experiments or project, including inputs, outputs, metadata, workflow steps, step relationships, tags, experiment groups, and lock status. Each step includes both recipeStepNumber (its stored position within its workflow step) and displayMixOrderNumber (the experiment editor’s mix-order number). Paginated by experiment ID.

Get Skill

get_skill · Read Only

Loads step-by-step instructions (skills) for working with this account’s data: orienting yourself in what entity types exist, finding, filtering, counting and comparing entities, reading measurements and curves, and creating or editing entities. Call it with no arguments to list every skill with when to use it. Then call it with skillName to load the steps and worked examples of that skill, and follow them with the other tools. The available skill names are edit-entities, orient-in-account, and query-uncountable-data.

Get Suggest Results

get_suggest_results · Read Only

Returns the formulations a completed suggest job generated, each with the model’s predicted values for the spec’s goals. Fails if the job has not completed successfully. Requires an ML training license.

List Aggregate

list_aggregate · Read Only

Queries aggregated data using a structured loading configuration. The referenced configuration must be an aggregation listing. Returns column metadata and aggregated row results.

List Entities

list_entities · Read Only

Lists entities using a structured loading configuration. Returns column metadata and entity results with their column values.

List Entity Definitions

list_entity_definitions · Read Only

Finds out what data this account tracks: lists each entity type with its entity definitions, named the way this account names them. Call it first when the user asks what data exists or names a kind of entity that you do not recognize. Each definition has a definitionId. Pass it as customEntityDefinitionId to listing_discover_columns for entity type custom_entity. The result ends with nextSteps that name the tools to call next.

This tool takes no arguments.

List ID Source

list_id_source · Read Only

List id and label pairs for a given id source spec. Supports pagination via offset and limit and text search filtering via search_label.

Listing Discover Columns

listing_discover_columns · Read Only

Finds the columns that the entities of one entity type can be read, filtered, and sorted by, such as their field values. Pass entity_type from the EntityType enum. For custom entities, pass custom_entity_definition_id from list_entity_definitions or find_custom_entity_definition. For recipes, measurement columns and calculations include only the user’s current material family, which the user selects in the web app. MCP tools cannot change it. Use name_contains or option_name_contains to narrow the catalog. Each option includes an opaque column token, the filter kinds that the column accepts, and a sortable flag. Copy the column token unchanged into listing_run_query, or pass the group name and option name, for example Experiment: Name, as its columnName. Results are paged by group. Pass nextCursor as cursor to read the next page.

Listing Run Query

listing_run_query · Read Only

Finds, counts, and compares entities of one type by their column values, without saving a listing. Name each column, filter, and sort column by its display name in columnName, or pass a column token from listing_discover_columns in column. listing_discover_columns is the precise path: it lists the exact names, column tokens, and filter kinds of each column. Omit columns to return the filter columns. Every returned row meets all filters, and totalResults counts the matching rows. Archived entities are excluded. Sort only on sortable columns. Results are paged with at most 100 rows per page. To read the next page, pass nextCursor as cursor with the same columns, filters, and sorts.

Lookup Entity

lookup_entity · Read Only

Looks up an entity by matching field values. Only text and ID field types are supported for matching. Returns the matched entity ID, or null if no match is found. Fails if multiple entities match. Excludes archived entities from results.

Match ID Source

match_id_source · Read Only

Match names to IDs using a given id source spec. Performs a reverse lookup, returning all matching IDs for each provided name. Accepts at most 10 names per request.

Resolve Entity Ids

resolve_entity_ids · Read Only

Resolves entity IDs to their display names. All requested entities must share the same entity type.

Search Entities

search_entities · Read Only

Finds what a name or value that the user mentions refers to: searches entity names and field values across every entity type at once, and returns each match with its entity type, entity id, and entity definition. Call it before you guess the entity type of a name, or when the user gives a value such as a code or a number instead of a name. Matching ignores case and extra spaces, and also finds similar spellings. The result ends with nextSteps that name the tools to call next.

Search Files And Notebooks

search_files_and_notebooks · Read Only

Searches the text and the names of the files and notebooks that the user can read, and returns the best matches with the matched text, the entity type, the entity id, and a URL to open each match. Call it when the user asks what a file or notebook says, or asks for files or notebooks about a topic. Call search_entities instead to find an entity by its name or a field value. The result ends with nextSteps that name the tools to call next.

Tools that modify data

Add Entity Comment

add_entity_comment · Modifies Data

Adds a comment to an entity, creating the entity’s comment thread when one does not exist yet. Watchers of the entity and of its comment thread are notified. Comments are not idempotent: each call adds a new comment.

Add File To Folder

add_file_to_folder · Modifies Data

Deprecated. Use modify_file_system with an upsert_file operation instead.

Add Notebook Content

add_notebook_content · Modifies Data

Appends content cells to an existing notebook. Resolves the notebook by identifier key and requires SET_FIELD_VALUE permission on the notebook entity. Supports multiple content types: markdown text, HTML text, tables with styled cells, chemical structures (SMILES, Ketcher, MOL 2000/3000, RXN, SDF, CDX), equations, file attachments, images, and reaction tables with reactants/products/catalysts/solvents. Currently only supports appending to the first page of the notebook.

Add Recipe To Project

add_recipe_to_project · Modifies Data · Idempotent

Adds an existing recipe to a project. The project may be in a different material family than the recipe.

Add Time Series Data

add_time_series_data · Modifies Data · Destructive

Adds timestamp-value data points to a time series segment identified by key. Supports configurable conflict resolution when a data point already exists at the same timestamp: either overwrite the existing value or raise an error. Returns whether a modification was made.

Archive Recipes

archive_recipes · Modifies Data · Destructive · Idempotent

Archives the provided recipes and their child recipes. Fails if any of the recipes are locked. An optional reason can be provided for the archive.

Associate Equipment Input

associate_equipment_input · Modifies Data · Idempotent

Create or return an input association for a piece of equipment within specified material families. The equipment is resolved via identifier key. Supports both direct invocation and async batch execution. Returns modification_made and result_id of the association.

Associate Recipe As Input

associate_recipe_as_input · Modifies Data · Idempotent

Associates a recipe as an input (ingredient). When no existing input is specified, creates a new input or returns the existing association if one already exists. When an existing input is specified, associates it with the recipe; fails if that input is already associated with a different recipe. Use disassociate_recipe_as_input to remove an existing association first. Returns the input ID and whether a modification was made.

Associate Recipe As Lot

associate_recipe_as_lot · Modifies Data · Idempotent

Creates a lot association between a recipe and an ingredient. The recipe becomes a lot for the specified ingredient. Returns whether a modification was made.

Clear Recipe Outputs

clear_recipe_outputs · Modifies Data · Destructive · Idempotent

Clears all output values and output metadata for a given recipe identified by key. Returns whether a modification was made.

Convert Recipe Workflow

convert_recipe_workflow · Modifies Data · Destructive · Idempotent

Moves an existing recipe (experiment) to another workflow of its material family, and optionally applies a workflow variant of that workflow. The workflow steps of the recipe map to steps of the new workflow by name and step number, and the call fails when inputs or process parameters cannot map. The call replaces the step relationships of the recipe, and moves the recipe from the default product project of its old workflow to that of the new workflow. Fails when the recipe is locked, or is used as an ingredient or as a workflow variant. Find recipe ids with list_id_source and entity type recipe, and workflow ids with list_id_source and entity type workflow.

Create Entities

create_entities · Modifies Data

Batch creates new entities of a specified type within a definition. Returns the list of created entity IDs and types.

Create Entity Links

create_entity_links · Modifies Data · Idempotent

Creates manual links between existing entities of any type, for example from a task to a recipe (experiment). Each link goes from one entity to another entity. You must be able to edit each from entity and view each to entity. A link that already exists is skipped. Returns the links that the call created.

Create Inputs

create_inputs · Modifies Data

Creates new inputs (ingredients or process parameters) in the specified material families. Each input must belong to at least one material family. Optionally sets attribute values, a category, and field values on creation.

Create Mix Order

create_mix_order · Modifies Data

Creates a mix order on a recipe workflow step. The recipe and workflow step are identified by their respective keys. Returns whether a modification was made.

Create Or Update Entities

create_or_update_entities · Modifies Data · Destructive

Bulk variant of create_or_update_entity scoped to a single (entity_type, definition_key) — accepts up to 100 operations sharing that scope and applies them via batched primitive calls (one permission check + one set_field_values across updates, one create_entities across creates). Returns one AsyncBatchActionReturn per input, in the same order. Cross-operation batch_reference dependencies are not supported.

Create Or Update Entity

create_or_update_entity · Modifies Data · Destructive

Creates a new entity or updates an existing one. If the entity already exists, updates its field values. Otherwise, creates a new entity under the specified definition. Returns the entity ID and whether a modification was made.

Create Recipe

create_recipe · Modifies Data

Creates a single recipe in the specified material family and workflow. If a matching recipe already exists, no new recipe is created and the existing recipe ID is returned. Returns the recipe ID.

Create Recipe Link

create_recipe_link · Modifies Data · Idempotent

Creates a directional link between two recipes of the specified type (child, control, user_link, or previous_experiment). Skips without error if the link already exists. A name is required for child and user_link types; control and previous_experiment links do not accept a name. Returns whether a modification was made.

Create Recipe Links

create_recipe_links · Modifies Data · Idempotent

Bulk variant of create_recipe_link scoped to a single link_type — accepts up to 100 link operations sharing that link_type and applies them via one batched primitive call. Returns one AsyncBatchActionReturn per input, in the same order. Cross-operation batch_reference dependencies are not supported.

Create Recipes

create_recipes · Modifies Data

Creates multiple recipes in a material family, optionally with metadata values. Returns the created recipe IDs in corresponding order.

Disassociate Recipe As Input

disassociate_recipe_as_input · Modifies Data · Destructive · Idempotent

Removes the input (ingredient) association from a recipe. If the recipe is not currently associated as an input, this is a no-op. Returns whether a modification was made.

Edit Recipe Inputs

edit_recipe_inputs · Modifies Data · Destructive

Applies a list of edits to inputs on a specific recipe workflow step. Supported edit types include clearing all inputs, upserting or adding inputs, updating annotations, setting lots, setting propagated percentages, changing basis, adding instructions, adding recipe steps, setting roles, and managing placeholders.

Grant Entity Permissions

grant_entity_permissions · Modifies Data · Idempotent

Grants permissions on an entity. Only permissions that do not already exist are added. Returns whether any new permissions were granted.

Invoke Uploader

invoke_uploader · Modifies Data · Destructive

Processes one or more uploaded files through a configured uploader, parsing and writing the extracted data to a recipe destination. Resolves the uploader by its identifier key, or selects it by detection keyword and file extension when uploader_key is null. Requires READ_ALL permission on the uploader entity. The file_ids parameter is preferred; file_id is deprecated. Non-SDK users should use file_upload/external_create_file_record to upload files first. SDK users can use the client.upload_files() helper method. Supports async batch execution.

Lock Entity

lock_entity · Modifies Data · Idempotent

Locks an entity to prevent modifications. Recipe entity types are not supported and must use the dedicated lock_recipes endpoint instead. Attempting to lock an already locked entity is a no-op.

Lock Recipes

lock_recipes · Modifies Data · Idempotent

Locks experiments to prevent editing. Supports locking all data (inputs and measurements) or inputs only. Returns whether a modification was made.

Modify File System

modify_file_system · Modifies Data · Destructive

Perform a file system operation on folders and files. upsert_folder creates a new folder or updates an existing one (name, type, and parent folder), reparenting it when a different parent_folder_key is given. upsert_entity_folder resolves or creates the entity folder attached to an entity. upsert_file adds a previously uploaded file to a folder. upsert_file_version records a previously uploaded file as a new document version on an existing file.

Push Notification

push_notification · Modifies Data

Send a notification to one or more users or user groups. Supports specifying a subject, message body, and optional entity link. Can optionally display as an in-app notice with custom configuration. Supports both direct invocation and async batch execution.

Remove Recipe From Project

remove_recipe_from_project · Modifies Data · Destructive · Idempotent

Removes a recipe from a project.

Remove Recipe Link

remove_recipe_link · Modifies Data · Destructive · Idempotent

Removes a directional link between two recipes of the specified type (child, control, user_link, or previous_experiment). If the link does not exist, the action is a no-op. Returns whether a modification was made.

Remove Recipe Workflow Step

remove_recipe_workflow_step · Modifies Data · Destructive

Removes a recipe workflow step from a recipe, together with the inputs on that step. A recipe must keep at least one recipe workflow step, so removing the last one fails; in a batch, all removals from the same recipe count toward this limit. Returns the id of the removed recipe workflow step.

Resolve Output Conditions

resolve_output_conditions · Modifies Data · Idempotent

Resolves sets of condition parameter values to output condition IDs, creating new output conditions if they do not already exist. Each condition request contains a list of condition parameter ID and value pairs. Validates that all condition parameter IDs exist, that each value matches the parameter’s quantity type (numeric vs string), and that exactly one of value_numeric or value_string is provided per parameter. Requires READ_ALL access on all referenced condition parameter entities. Returns resolved output condition IDs in the same order as the request.

Run Trigger

run_trigger · Modifies Data · Destructive

Executes a trigger script identified by ref name, optionally on a specific entity, and returns only after the trigger has fully completed. Requires admin user access; non-admin users receive a 403 error. Accepts either entity_identifier (preferred) or entity (deprecated) to specify the target entity, but not both. Returns whether any entities were modified by the trigger execution.

Set Barcode

set_barcode · Modifies Data · Destructive · Idempotent

Sets the barcode value for an entity. Returns whether the new barcode value was set.

Set Core Permissions

set_core_permissions · Modifies Data · Destructive · Idempotent

Grants, removes, or replaces core permissions for users or user groups at a specified scope. Scopes include: all_material_families, material_family, project, or recipe. Project and recipe scopes only support recipe-related permission types (read/write recipe, add recipe). Material family scopes do not accept individual user permissions (only user groups). Requires at least one user_id or user_group_id. Update types: ‘append’ grants the specified permissions (with implied permissions), ‘remove’ revokes them (including dependent permissions), ‘override’ replaces all permissions at the scope with the specified set.

Set Entities Field Values

set_entities_field_values · Modifies Data · Destructive · Idempotent

Bulk variant of set_entity_field_values scoped to a single entity_type — accepts up to 100 (identifier_key, field_values) operations sharing that scope and applies them via batched primitive calls (one entity-resolution round-trip, one check_entity_list_permitted, one set_field_values across the aggregate). Returns one AsyncBatchActionReturn per input, in the same order. Cross-operation batch_reference dependencies are not supported.

Set Entity Field Values

set_entity_field_values · Modifies Data · Destructive · Idempotent

Sets field values on an entity. Returns whether the field values were modified.

Set Entity Permission

set_entity_permission · Modifies Data · Destructive · Idempotent

Sets entity-level permissions (read, write, admin) on a specific entity for users, user groups, or every user. Currently supports file_folder_membership entities. Update types: ‘append’ grants the requested level if higher than existing, ‘remove’ revokes the specified level and downgrades to the level below (e.g., removing write leaves read), ‘override’ replaces all user and user group permissions with the specified set, and changes the all-users permission only when the request names the all-users recipient. Each user or user group may only appear once in the request, and the all-users recipient may appear at most once. The caller cannot modify their own permissions. Requires SET_FIELD_VALUE access on the target entity. Returns whether any modification was made.

Set Input Attribute Values

set_input_attribute_values · Modifies Data · Destructive · Idempotent

Sets attribute values on one or more inputs. Supports numeric, categorical/text, and PDF file attributes. For PDF attributes, provide exactly one file_id referencing a previously uploaded file; use create_file_record to obtain a file_id. Each (input_id, attribute_id) pair may only appear once in the request. Validates that each attribute ID exists and that the provided value type matches the attribute’s quantity type.

Set Input Category

set_input_category · Modifies Data · Destructive · Idempotent

Sets or unsets the global category for an input within its material families. Pass a category_id to assign a category, or null to remove the current category. Optionally scope the update to specific material families via material_family_ids; if omitted, updates across all material families the input belongs to. Validates that the category exists. Requires SET_FIELD_VALUE access on the input entity.

Set Input Subcategories

set_input_subcategories · Modifies Data · Destructive · Idempotent

Modifies the subcategory (tag) assignments for an input. Supports three update types: ‘append’ adds the specified subcategories without removing existing ones, ‘override’ replaces all subcategories with the specified set (archiving any not in the list), and ‘remove’ archives only the specified subcategories. Requires SET_FIELD_VALUE access on the input entity.

Set Intermediate Type

set_intermediate_type · Modifies Data · Destructive · Idempotent

Sets whether an intermediate ingredient is treated as a final product or as a compound-as-intermediate. Setting to compound_as_intermediate enables compound-as-intermediate behavior; setting to final_product disables it. Requires SET_FIELD_VALUE access on the input entity.

Set Recipe Inputs

set_recipe_inputs · Modifies Data · Destructive · Idempotent

Sets input values for experiments. Supports numeric, text, and categorical types. Validates that the recipe step belongs to the correct recipe. Each entry edits one input on one recipe with a single operation: set the value (the actual value when set_actual_value is true, otherwise the set value), associate a lot (lot_recipe_id, created if the recipe is not already a lot), or remove the input (remove). A lot association targets the set value; combining it with set_actual_value fails. Writes all values to the first workflow step when no step is specified. Fails if both a numeric and string value are provided.

Set Recipe Metadata

set_recipe_metadata · Modifies Data · Destructive · Idempotent

Sets metadata values on a recipe identified by key. Accepts a list of metadata field-value pairs to populate on the recipe. Fails if any of the metadata fields are read-only.

Set Recipe Output Annotations

set_recipe_output_annotations · Modifies Data · Destructive · Idempotent

Updates annotations on experiment outputs. Supports two modes per update – merge (adds annotations alongside existing ones) or replace (clears existing annotations first).

Set Recipe Outputs

set_recipe_outputs · Modifies Data · Destructive · Idempotent

Sets output measurement values for experiments. Supports numeric, text, categorical, curve, color, and recipe-as-output types. Fails if both a numeric and string value are provided. Experiment number must be 1 or greater. Use resolve_output_conditions to obtain a condition ID when setting conditioned outputs. Supports configurable null behavior (do nothing, ensure output exists, or remove the output row).

Set Recipe Tags

set_recipe_tags · Modifies Data · Destructive · Idempotent

Modifies tags on a recipe identified by key. Supports three update modes – append (adds tags to existing ones), override (replaces all tags with the provided set), or remove (removes the specified tags).

Set Recipe Total

set_recipe_total · Modifies Data · Destructive · Idempotent

Sets the total quantity value in a given quantity basis for a recipe or a specific workflow step within it. Optionally associates a linked basis calculation. Returns whether a modification was made.

Set Values

set_values · Modifies Data · Destructive · Idempotent

Sets field values on an entity. Returns an empty response on success.

Submit Async Job

submit_async_job · Modifies Data

Submits a machine learning job. Returns an async_job_id immediately. The job itself takes minutes, so read the async_job entity’s status field until it is no longer queued or in progress. Suggest and analyze jobs require an ML training license. Model exports require an ML license.

Swap Output Condition Parameters

swap_output_condition_parameters · Modifies Data · Destructive

Swap output condition parameters on recipes. Either specify recipe keys for targeted swaps or set swap_all to swap across all recipes in the project.

Transition Entity Phase

transition_entity_phase · Modifies Data · Destructive

Transitions an entity from one workflow phase to another. Fails if no valid transition exists between the specified phases, or if multiple transitions exist for the same phase pair.

Unarchive Recipes

unarchive_recipes · Modifies Data · Idempotent

Restores previously archived recipes, making them active again. Fails if any of the recipes are locked.

Unlock Entity

unlock_entity · Modifies Data · Idempotent

Removes the lock from an entity, allowing modifications again. Recipe entity types are not supported and must use the dedicated unlock_recipes endpoint instead. Attempting to unlock an already unlocked entity is a no-op.

Unlock Recipes

unlock_recipes · Modifies Data · Idempotent

Unlocks previously locked experiments, making them editable again. Returns whether a modification was made.

Update Entity Material Families

update_entity_material_families · Modifies Data · Destructive · Idempotent

Update the material family assignments for an entity. Use update_type to append, override, or remove material family associations. Prevents removing all material families from an entity.

Update Output Condition Parameter

update_output_condition_parameter · Modifies Data · Destructive · Idempotent

Adds, updates, or removes a condition parameter assignment on an output. Use update_type ‘append’ to add or update the requirement level (none, required, warning, prompt) for a condition parameter on the output; requirement_type is required for append. Use ‘remove’ to delete the condition parameter association. ‘override’ is not supported. Optionally scope to a specific material family; if omitted, creates a global setting. Resolves output, condition parameter, and material family via identifier keys.

Upsert Condition Match

upsert_condition_match · Modifies Data · Destructive · Idempotent

Creates or updates a condition match record. Condition matches are used to set goals on outputs. Each call creates a new condition match — there is no idempotent behavior, so the same inputs will produce a new condition match with each invocation. Each condition parameter’s match_type selects how it is matched: range matches min_value/max_value bounds, eq matches exact numeric value(s) supplied in categorical_values (each as a string), eqCategorical matches exact categorical value(s) in categorical_values, and all matches any value. Returns modification_made and result_id of the created or updated condition match.

Upsert Condition Matches

upsert_condition_matches · Modifies Data · Destructive · Idempotent

Bulk variant of upsert_condition_match. Accepts a list of upsert arguments and applies them via a single batched database round-trip per bulk operation (insert, update, delete) through the shared upsert_condition_matches helper. Returns one AsyncBatchActionReturn per input in the same order.

Upsert Field Options

upsert_field_options · Modifies Data · Destructive · Idempotent

Create or update field options within an option set. The option_id field is what uniquely identifies each entry within the option set — provide the same option_id to update an existing option. Validates that no duplicate option_id values are provided within the request. Supports setting option labels, archived status, and subset assignments. Fields not provided on an existing option are left unchanged.

Upsert Recipe Workflow Step

upsert_recipe_workflow_step · Modifies Data · Destructive · Idempotent

Create or update a recipe workflow step on a recipe.

Upsert Step Relationships

upsert_step_relationships · Modifies Data · Destructive · Idempotent

Upsert step relationships on a recipe.

For further assistance, contact Uncountable support or consult the platform documentation.