Skip to main content
Framer logo
  • Category: website & app building
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 157
  • Triggers: 0
  • Slug: FRAMER
  • Version: 20261101_00

Tools

Slug: FRAMER_ADD_COLLECTION_FIELDSCreate or update typed field definitions in a CMS collection.

Input Parameters

array
required
Typed fields to create or update; include id for updates and omit it for creates.
string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_COLLECTION_ITEMSCreate or update CMS collection items with typed, tagged field values.

Input Parameters

array
required
Items to create or update; use id for updates and slug for creates.
string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_COMPONENT_INSTANCEInsert a component instance by component module URL.

Input Parameters

string
required
Framer component module URL.
string
Optional parent node ID; omit to use Framer’s current selection context.
object
Optional editable component-instance attributes, including controls and layout values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_DETACHED_COMPONENT_LAYERSInsert editable component layers using the current editor selection/context without retaining an instance. This action does not accept a target page. Attributes are forwarded to Framer, but Framer currently ignores them when producing the detached output and returns the component defaults instead.

Input Parameters

string
required
Framer component module URL.
boolean
Whether to insert as a layout block and match breakpoints.
object
Optional attributes forwarded to Framer’s temporary component instance. Framer currently returns detached layers with the component defaults instead of applying these values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_ENUM_CASEAdd a case to an enum field or enum variable.

Input Parameters

string
required
EnumField field ID or EnumVariable variable ID.
string
required
Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
object
required
Enum case attributes to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_IMAGEUpload one image and insert it using the current editor selection/context. This action does not accept a target page.

Input Parameters

string
required
Image to upload and insert on the canvas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_IMAGESUpload and insert multiple images using the current editor selection/context. This action does not accept a target page.

Input Parameters

array
required
Images to upload and insert on the canvas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_MANAGED_COLLECTION_ITEMSAdd or synchronize managed CMS items with typed, tagged field values and stable external IDs.

Input Parameters

array
required
Managed items to add or synchronize by stable external ID.
string
required
Managed CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_REDIRECTSCreate project redirects, or update existing redirects by including their IDs; all changes take effect on a subsequent publish.

Input Parameters

array
required
Redirects to create, or existing redirects to update by ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_SVGInsert an SVG on the canvas or replace the selected SVG.

Input Parameters

string
required
Serialized SVG markup to insert.
string
Optional name for the inserted SVG layer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_ADD_TEXTInsert text using the current editor selection/context. This action does not accept a target page.

Input Parameters

string ("h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p")
Optional semantic HTML tag for the inserted text.
string
required
Plain text content to insert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_APPLY_AGENT_CHANGESExecute Framer’s agent command DSL on a project page.

Input Parameters

string
required
Agent command DSL to execute.
string
Page route on which to apply the commands.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CLONE_DESIGN_PAGEClone a design page by node ID, optionally requesting a name.

Input Parameters

object
Optional naming settings for the cloned page.
string
required
ID of the DesignPageNode to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CLONE_NODEClone a node by ID.

Input Parameters

string
required
Framer canvas node ID to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CLONE_WEB_PAGEClone a web page by node ID, optionally requesting a route path.

Input Parameters

object
Optional route settings for the cloned page.
string
required
ID of the WebPageNode to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_BRANCHCreate a Framer project branch from the active branch or a specified base, then switch the editor and API session to the new branch.

Input Parameters

string
Human-readable branch title.
string
Branch to use as the base; omit to use the active branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_BRANCH_FOR_AGENTCreate an agent branch from the active branch and switch to it.

Input Parameters

string
Human-readable branch title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_CODE_FILECreate a Framer code file with initial source content.

Input Parameters

string
required
Initial source code for the file.
string
required
Name for the new code file.
boolean
Whether plugin tooling should edit the new file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_COLLECTIONCreate a user-owned CMS collection in the connected Framer project.

Input Parameters

string
required
Human-readable name for the new CMS collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_COLOR_STYLECreate a reusable color style in the connected Framer project.

Input Parameters

string
Optional dark-appearance color, or null.
string
Color style name; use slashes to create asset folders.
string
Alternative hierarchical asset path for the style.
string
required
Light-appearance color in a Framer-supported CSS format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_COMPONENT_NODECreate a smart component node with a name.

Input Parameters

string
required
Name for the new smart component.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_DESIGN_PAGECreate a design page.

Input Parameters

string
required
Name of the design page to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_FRAME_NODECreate a frame node, optionally below a parent.

Input Parameters

string
Parent canvas node ID, or null to create at the canvas root.
object
required
Initial editable frame attributes; omitted fields use Framer defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_LOCALECreate a project locale.

Input Parameters

string
Human-readable name for the new locale.
string
URL slug for the locale.
boolean
Whether the locale starts in draft state.
string
Optional ISO region code for the locale.
string
required
BCP 47 language code, such as en or fr.
string
Existing locale ID to use when a translation is unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_MANAGED_COLLECTIONCreate a plugin-managed CMS collection in the connected project.

Input Parameters

string
required
Human-readable managed collection name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_TEXT_NODECreate a text node, optionally below a parent.

Input Parameters

string
Parent canvas node ID, or null to create at the canvas root.
object
required
Initial editable text-node attributes; omitted fields use Framer defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_TEXT_STYLECreate a reusable text style in the connected Framer project.

Input Parameters

object
required
Text style attributes accepted by Framer SDK 5.1.0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_CREATE_WEB_PAGECreate a web page at a route path.

Input Parameters

string
required
Route path for the new web page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_DELETE_BRANCHDelete an explicit project branch, switching to its base if active.

Input Parameters

string
required
Branch ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_DELETE_BRANCH_FOR_AGENTDelete a branch in the agent workflow.

Input Parameters

string
required
Branch ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_DEPLOYPromote an existing Framer deployment to explicit domains or to the project’s configured production domains.

Input Parameters

array
Domain names to receive this deployment; omit to use the project’s configured domains.
string
required
Deployment ID returned by publish or list deployments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_EXPORT_SVGExport a node as serialized SVG through Framer’s dedicated WebSocket side channel.

Input Parameters

string
required
Framer canvas node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_FLATTEN_COMPONENT_INSTANCE_FOR_AGENTReplace a component instance with editable local layers.

Input Parameters

string
required
ID of the component instance to flatten.
string
Page route containing the instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_ACTIVE_BRANCHGet the branch currently active for the Framer editor and API session, including its base, contributor state, and creator metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_ACTIVE_BRANCH_FOR_AGENTGet metadata for the branch active in the Framer agent session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_AGENT_CONTEXTGet dynamic project context for Framer’s agent command and query APIs.

Input Parameters

string
Page route used to scope the agent context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_AGENT_SYSTEM_PROMPTGet Framer’s static agent prompt, including its command and project-query DSL references.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_ANCESTORS_FOR_AGENTGet a node’s ancestors from its parent through the page root.

Input Parameters

string
required
ID of the node whose ancestor chain should be returned.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_BRANCH_CHANGESGet semantic changes in a branch relative to its base branch.

Input Parameters

string
required
Branch ID whose changes should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_BRANCH_CHANGES_FOR_AGENTGet a summarized changelog for a project branch relative to its base.

Input Parameters

string
required
Branch ID whose summarized changes to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_BRANCHESReturn every project branch, a selected set, or one branch by passing zero, many, or one branch ID.

Input Parameters

array
Branch IDs to return; pass one ID for one branch, or an empty list to return all branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_BRANCHES_FOR_AGENTList project branches available to the Framer agent session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CANVAS_ROOTGet the root node of the current canvas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CHANGE_CONTRIBUTORSGet contributors who changed the project in an optional version range.

Input Parameters

integer
Last project version to include.
integer
First project version to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CHANGED_PATHSGet page paths added, removed, or modified between the active project version and its previously published version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CHILDRENGet a node’s canvas children.

Input Parameters

string
required
Framer canvas node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CODE_FILEGet one Framer code file by ID or project-relative path.

Input Parameters

string
required
Code file ID or project-relative path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CODE_FILESList code files and their current contents in the connected Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CODE_FILE_VERSION_CONTENTGet the source content of a saved Framer code file version.

Input Parameters

string
required
Code file ID captured from a CodeFileVersion object.
string
required
Version ID captured from a CodeFileVersion object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CODE_FILE_VERSIONSList saved versions of a Framer code file.

Input Parameters

string
required
Code file ID captured from a CodeFile object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLLECTIONGet one CMS collection by its node ID.

Input Parameters

string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLLECTION_FIELDSList all field definitions in a CMS collection, including dividers.

Input Parameters

string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLLECTION_ITEMSList items and typed field values in a CMS collection.

Input Parameters

string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLLECTIONSList managed and user-owned CMS collections in the connected Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLOR_STYLEGet one reusable color style by ID.

Input Parameters

string
required
Color style node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_COLOR_STYLESList reusable color styles in the connected Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CURRENT_USERGet the Framer user whose identity and project permissions are represented by the connected project API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_CUSTOM_CODEGet custom HTML and disabled state for all four project document injection locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_DEFAULT_LOCALEGet the project’s default locale.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_DEPLOYMENTGet the latest status snapshot, timestamps, creator, preview URL, and failure stage for one Framer deployment.

Input Parameters

string
required
Deployment ID returned by publish or list deployments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_DEPLOYMENT_ISSUESGet optimization warnings and errors for a Framer deployment, including related node IDs when available.

Input Parameters

string
required
Deployment ID returned by publish or list deployments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_DESCENDANT_REFERENCES_OF_TYPES_FOR_AGENTGet matching style or token nodes referenced by descendants.

Input Parameters

string
required
ID of the node whose descendant references should be searched.
array
required
Provider-defined referenced node type names to match.
string
Page route to search; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_DESCENDANTS_OF_TYPES_FOR_AGENTGet descendants of a node matching provider-defined node types.

Input Parameters

string
required
ID of the node whose descendants should be searched.
array
required
Provider-defined node type names to match.
string
Page route to search; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_FONTGet one available font variant by family, weight, and style.

Input Parameters

string
required
Font family name; matching is case-insensitive.
object
Optional weight and style match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_FONTSList individual font files and variants available to the Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_GROUND_NODE_FOR_AGENTGet the top-level canvas node containing a node.

Input Parameters

string
required
ID of the node whose top-level canvas node should be returned.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_LOCALE_LANGUAGESList valid locale language codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_LOCALE_REGIONSList valid region codes for a language.

Input Parameters

string
required
BCP 47 language code, such as en or fr.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_LOCALESList configured non-default locales.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_LOCALIZATION_GROUPSGet localization groups, optionally filtered by IDs or type.

Input Parameters

array
Localization group IDs to include; omit to include all matching groups.
string ("collection" | "collection-item" | "component" | "page" | "settings" | "template")
Localization group type to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_MANAGED_COLLECTION_FIELDSList supported fields in a plugin-managed Framer CMS collection.

Input Parameters

string
required
Collection ID captured from a ManagedCollection object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_MANAGED_COLLECTION_ITEM_IDSList external item IDs in a plugin-managed CMS collection.

Input Parameters

string
required
Managed CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_MANAGED_COLLECTIONSList plugin-managed CMS collections available to the connected API session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODEGet a project node by ID.

Input Parameters

string
required
Framer canvas node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODE_FOR_AGENTGet one serialized Framer node and its children by ID.

Input Parameters

string
required
ID of the node to retrieve.
string
Page route containing the node.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODES_FOR_AGENTGet serialized Framer nodes and their children by ID.

Input Parameters

array
required
Node IDs to retrieve in input order.
string
Page route containing the nodes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODES_OF_TYPES_FOR_AGENTGet all nodes of selected types on a Framer page without children.

Input Parameters

array
required
Node type names to match.
string
Page route to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODES_WITH_ATTRIBUTEGet project nodes whose node type supports an attribute, whether or not it is set.

Input Parameters

string ("name" | "visible" | "locked" | "backgroundColor" | "backgroundImage" | "backgroundGradient" | "rotation" | "opacity" | "borderRadius" | "border" | "overflow" | "overflowX" | "overflowY" | "componentIdentifier" | "insertURL" | "componentName" | "controls" | "typedControls" | "svg" | "position" | "top" | "right" | "bottom" | "left" | "centerX" | "centerY" | "width" | "height" | "maxWidth" | "minWidth" | "maxHeight" | "minHeight" | "aspectRatio" | "textTruncation" | "imageRendering" | "zIndex" | "font" | "inlineTextStyle" | "draft" | "path" | "collectionId" | "layout" | "stackDirection" | "stackDistribution" | "stackAlignment" | "stackWrapEnabled" | "gridColumnCount" | "gridRowCount" | "gridAlignment" | "gridColumnWidthType" | "gridColumnWidth" | "gridColumnMinWidth" | "gridRowHeightType" | "gridRowHeight" | "gap" | "padding" | "gridItemFillCellWidth" | "gridItemFillCellHeight" | "gridItemHorizontalAlignment" | "gridItemVerticalAlignment" | "gridItemColumnSpan" | "gridItemRowSpan" | "isVariant" | "isPrimaryVariant" | "gesture" | "inheritsFromId" | "isBreakpoint" | "isPrimaryBreakpoint" | "link" | "linkOpenInNewTab" | "linkSmoothScroll" | "linkClickTrackingId" | "linkRelValues" | "linkPreserveParams")
required
Node attribute whose supporting node classes should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODES_WITH_ATTRIBUTE_SETGet project nodes where a supported attribute has a non-null value.

Input Parameters

string ("name" | "visible" | "locked" | "backgroundColor" | "backgroundImage" | "backgroundGradient" | "rotation" | "opacity" | "borderRadius" | "border" | "overflow" | "overflowX" | "overflowY" | "componentIdentifier" | "insertURL" | "componentName" | "controls" | "typedControls" | "svg" | "position" | "top" | "right" | "bottom" | "left" | "centerX" | "centerY" | "width" | "height" | "maxWidth" | "minWidth" | "maxHeight" | "minHeight" | "aspectRatio" | "textTruncation" | "imageRendering" | "zIndex" | "font" | "inlineTextStyle" | "draft" | "path" | "collectionId" | "layout" | "stackDirection" | "stackDistribution" | "stackAlignment" | "stackWrapEnabled" | "gridColumnCount" | "gridRowCount" | "gridAlignment" | "gridColumnWidthType" | "gridColumnWidth" | "gridColumnMinWidth" | "gridRowHeightType" | "gridRowHeight" | "gap" | "padding" | "gridItemFillCellWidth" | "gridItemFillCellHeight" | "gridItemHorizontalAlignment" | "gridItemVerticalAlignment" | "gridItemColumnSpan" | "gridItemRowSpan" | "isVariant" | "isPrimaryVariant" | "gesture" | "inheritsFromId" | "isBreakpoint" | "isPrimaryBreakpoint" | "link" | "linkOpenInNewTab" | "linkSmoothScroll" | "linkClickTrackingId" | "linkRelValues" | "linkPreserveParams")
required
Node attribute that must have a non-null value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_NODES_WITH_TYPEGet all nodes of a known class, optionally below a parent node.

Input Parameters

string ("FrameNode" | "TextNode" | "SVGNode" | "ComponentInstanceNode" | "WebPageNode" | "DesignPageNode" | "ComponentNode" | "ShapeContainerNode" | "PathNode" | "ShapeGroupNode" | "BooleanShapeNode")
required
Concrete Framer node class to return.
string
Parent node ID to search below, or null to search the whole project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_PARENTGet a node’s parent.

Input Parameters

string
required
Framer canvas node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_PARENT_NODE_FOR_AGENTGet the direct parent of a node.

Input Parameters

string
required
ID of the node whose direct parent should be returned.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_PROJECT_INFOGet the connected Framer project’s current identity and legacy migration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_PUBLISH_INFOGet the connected project’s current staging and production publication URLs, deployment times, and optimization states.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_RECTGet the bounding rectangle of a Framer node.

Input Parameters

string
required
Framer canvas node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_RECT_FOR_AGENTGet a node’s rounded canvas rectangle.

Input Parameters

string
required
ID of the node whose rounded canvas rectangle is needed.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_REDIRECTSList the project’s redirects, including source and destination paths and locale expansion behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_SCOPE_NODE_FOR_AGENTGet the enclosing page or component scope for a node.

Input Parameters

string
required
ID of the node whose enclosing scope should be returned.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_TEXT_FOR_NODEGet the plain-text content of a text node by ID.

Input Parameters

string
required
ID of the TextNode whose plain text to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_TEXT_STYLEGet one reusable text style by ID.

Input Parameters

string
required
Text style node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_TEXT_STYLESList reusable text styles in the connected Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_UNPUBLISHED_PAGE_CHANGESList web pages added, updated, or removed since the active branch was last published.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_VECTOR_SET_ITEMSList vector items in one Framer vector set.

Input Parameters

string
required
Vector set ID returned by Get Vector Sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_VECTOR_SET_ITEM_VARIABLESList customizable variables for one Framer vector-set item.

Input Parameters

string
required
Module ID returned with the vector set item.
string
required
Vector set item ID returned by Get Vector Set Items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_GET_VECTOR_SETSList vector icon sets available to the connected Framer project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_JOIN_BRANCHJoin an explicit project branch as a contributor.

Input Parameters

string
required
Branch ID to join as a contributor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_JOIN_BRANCH_FOR_AGENTJoin a branch as a contributor for agent editing.

Input Parameters

string
required
Branch ID to join as a contributor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LEAVE_BRANCHLeave an explicit project branch as a contributor.

Input Parameters

string
required
Branch ID to leave as a contributor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LEAVE_BRANCH_FOR_AGENTLeave a branch as a contributor.

Input Parameters

string
required
Branch ID to leave as a contributor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LINT_CODEDeprecated Framer lint operation retained for compatibility; SDK 5.1.0 documents it as a no-op.

Input Parameters

string
required
Source code to pass to the deprecated linter.
string ("error" | "warning")
required
Severity for the removed forbid-browser-apis rule.
string
required
Code file name used in diagnostics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LIST_COMPONENTS_FOR_AGENTList project, external, and additional components available to the agent.

Input Parameters

string
Page route used to scope the component catalog.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LIST_DEPLOYMENTSList one cursor-controlled page of deployments for the active Framer branch, returning at most 30 records.

Input Parameters

integer
Maximum deployments to return in this page (1-30).
string
Opaque continuation cursor returned by the preceding call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LIST_ICON_SETS_FOR_AGENTList project, external, and additional icon sets available to the agent on the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_LIST_LOCALIZATION_GROUPS_NEXTList all localization groups from Framer’s session-bound iterator. The action consumes every cursor on one WebSocket connection and returns the complete list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_MAKE_EXTERNAL_COMPONENT_LOCAL_FOR_AGENTCopy an external component into the project and optionally replace all instances.

Input Parameters

string
required
ID of the external component instance.
string
Page route containing the component.
boolean
Whether to replace every instance after provider confirmation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_MERGE_BRANCHMerge an explicit source branch into its base or a compatible target.

Input Parameters

string
required
Source branch ID to merge.
string
Target branch ID; omit to merge into the source branch base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_MERGE_BRANCH_FOR_AGENTMerge the active agent branch into its base or an explicit target, then switch to the target.

Input Parameters

string
Merge target branch ID; use “main” for the main branch or omit to use the active branch base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_PAGINATE_FOR_AGENTPaginate a complete item list to completion within one Framer WebSocket session and return all results.

Input Parameters

array
required
Complete items to paginate within this action invocation.
string
Page route to inspect; defaults to the active page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_PUBLISHPublish the active Framer branch and return the resulting deployment plus its preview or staging hostnames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_PUBLISH_FOR_AGENTRun an agent publish operation, including production deployment when requested.

Input Parameters

object
Action-discriminated input defined by Framer’s agent system prompt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_QUERY_ANALYTICS_FOR_AGENTRun an analytics query over an ISO date range.

Input Parameters

string
Optional analytics range end as an ISO string.
string
required
Analytics query to execute.
string
required
Inclusive analytics range start as an ISO string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_QUERY_IMAGES_FOR_AGENTSearch Framer’s agent image sources and return candidate images.

Input Parameters

object
required
Image source and search options from the agent system prompt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_COMPONENT_CONTROLS_FOR_AGENTRead provider-defined controls for project components on the active page.

Input Parameters

array
required
Component IDs whose provider-defined controls to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_ICON_SET_CONTROLS_FOR_AGENTRead provider-defined controls for icon sets on the active page.

Input Parameters

array
required
Icon-set IDs whose provider-defined controls to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_ICONS_FOR_AGENTRead exact icon names from an icon set on the active page.

Input Parameters

string
required
Icon-set ID whose exact icon names to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_LAYOUT_TEMPLATE_CONTROLS_FOR_AGENTRead provider-defined controls for layout templates on the active page.

Input Parameters

array
required
Layout-template IDs whose provider-defined controls to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_PROJECT_FOR_AGENTExecute agent query objects against project state.

Input Parameters

array
required
Agent query objects using the exact DSL returned by Framer’s agent system prompt.
string
Page route used to scope the project query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_READ_SHADER_CONTROLS_FOR_AGENTRead provider-defined controls for shaders on the active page.

Input Parameters

array
required
Shader names whose provider-defined controls to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_CODE_FILERemove a Framer code file.

Input Parameters

string
required
Code file ID captured from a CodeFile object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_COLLECTION_FIELDSRemove one or more fields from a CMS collection.

Input Parameters

array
required
IDs of collection fields to remove.
string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_COLLECTION_ITEMSRemove CMS collection items by item or node ID.

Input Parameters

array
required
CMS item or node IDs to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_COLOR_STYLERemove a reusable Framer color style.

Input Parameters

string
required
Style ID captured from a ColorStyle object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_ENUM_CASERemove a case from an enum field or enum variable.

Input Parameters

string
required
ID of the enum case to remove.
string
required
EnumField field ID or EnumVariable variable ID.
string
required
Collection ID for an EnumField, or component/collection node ID for an EnumVariable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_MANAGED_COLLECTION_ITEMSRemove items from a managed CMS collection by external item ID.

Input Parameters

array
required
External IDs of managed collection items to remove.
string
required
Managed CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_NODESRemove one or more canvas nodes by ID; pass a one-element list to remove one node.

Input Parameters

array
required
One or more canvas node IDs to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_REDIRECTSRemove project redirects by ID; unknown IDs are ignored by Framer.

Input Parameters

array
required
Redirect IDs to remove; Framer ignores IDs that do not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REMOVE_TEXT_STYLERemove a reusable Framer text style.

Input Parameters

string
required
Style ID captured from a TextStyle object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_RENAME_BRANCHRename an explicit project branch.

Input Parameters

string
required
New human-readable branch title.
string
required
Branch ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_RENAME_BRANCH_FOR_AGENTRename a branch for the agent workflow.

Input Parameters

string
required
New human-readable branch title.
string
required
Branch ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_RENAME_CODE_FILERename a Framer code file.

Input Parameters

string
required
New code file name.
string
required
Code file ID captured from a CodeFile object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_REPLACE_TEXT_FOR_AGENTReplace exact text within one Framer text node.

Input Parameters

string
required
ID of the text node to update.
string
Page route containing the text node.
string
required
Exact text to find in the node.
string
required
Text to substitute for each match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SCREENSHOT_NODECapture a node screenshot through Framer’s dedicated WebSocket side channel.

Input Parameters

object
Optional clipping rectangle in CSS pixels before scaling.
number
Pixel-density multiplier; Framer defaults to 1.
string ("png" | "jpeg")
Image format; Framer defaults to png.
string
required
Framer canvas node ID.
integer
JPEG quality from 0 to 100; only applies to jpeg.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SERIALIZE_FOR_AGENTSerialize a node with optional depth, attribute, and ancestor filtering.

Input Parameters

string
required
ID of the node to serialize.
integer
Maximum descendant depth to include.
string
Page route to inspect; defaults to the active page.
boolean
Whether to include the node’s ancestor path.
array
Node attribute names to include in the serialization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SERIALIZE_NODES_FOR_AGENTSerialize multiple nodes with optional depth, attribute, and ancestor filtering.

Input Parameters

array
required
IDs of nodes to serialize in input order.
integer
Maximum descendant depth to include.
string
Page route to inspect; defaults to the active page.
boolean
Whether to include each node’s ancestor path.
array
Node attribute names to include in each serialization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_CODE_FILE_CONTENTReplace the source content of a Framer code file.

Input Parameters

string
required
Complete source content to write to the code file.
string
required
Code file ID captured from a CodeFile object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_COLLECTION_FIELD_ORDERSet the display order of fields in a CMS collection.

Input Parameters

array
required
All collection field IDs in the desired display order.
string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_COLLECTION_ITEM_ATTRIBUTESUpdate one CMS item’s slug, typed fields, locale status, or draft state.

Input Parameters

string
required
CMS item or node ID to update.
object
required
Item attributes to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_COLLECTION_ITEM_ORDERSet the item order in a CMS collection.

Input Parameters

array
required
All CMS item IDs in the desired order.
string
required
CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_COLOR_STYLE_ATTRIBUTESUpdate selected attributes of a reusable Framer color style.

Input Parameters

object
required
Color style attributes to update.
string
required
Style ID captured from a ColorStyle object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_CUSTOM_CODESet custom HTML at one Framer document injection location, or clear that location by passing null or omitting HTML.

Input Parameters

string
HTML to inject, or null to clear the selected location.
string ("headStart" | "headEnd" | "bodyStart" | "bodyEnd")
required
Document location where the custom HTML is injected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_ENUM_CASE_ORDERSet the case order for an enum field or enum variable.

Input Parameters

string
required
EnumField field ID or EnumVariable variable ID.
array
required
IDs of all enum cases in the desired order.
string
required
Collection ID for an EnumField, or component/collection node ID for an EnumVariable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_LOCALIZATION_DATASet localized values and per-locale group status. The result includes per-value and per-group status update errors.

Input Parameters

object
required
Localized values and group statuses keyed by source, group, and locale IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_MANAGED_COLLECTION_FIELDSReplace and synchronize the typed field schema of a managed CMS collection.

Input Parameters

array
required
Complete managed field schema to synchronize.
string
required
Managed CMS collection node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_MANAGED_COLLECTION_ITEM_ORDERSet item order in a plugin-managed Framer CMS collection.

Input Parameters

array
required
Managed item IDs in the desired order.
string
required
Collection ID captured from a ManagedCollection object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_NODE_ATTRIBUTESPatch editable attributes on a node. Only explicitly supplied attributes are sent.

Input Parameters

string
required
Framer canvas node ID.
object
required
Editable attributes supported by the target node class; omitted fields are unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_PARENTMove a node to a new parent and optional child index.

Input Parameters

integer
Optional zero-based child position under the new parent.
string
required
Node to move.
string
required
New parent node ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_REDIRECT_ORDERSet the evaluation and display order of project redirects; unknown redirect IDs are ignored.

Input Parameters

array
required
Redirect IDs in the desired order; Framer ignores IDs that do not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_TEXTSet text on the current selection or insert it when appropriate.

Input Parameters

string
required
Plain text to set on the current selection or insert when appropriate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SET_TEXT_STYLE_ATTRIBUTESUpdate selected attributes of a reusable Framer text style.

Input Parameters

object
required
Text style attributes to update.
string
required
Style ID captured from a TextStyle object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SWITCH_BRANCHSwitch the editor and subsequent edits to an explicit branch.

Input Parameters

string
required
Branch ID to activate; use “main” for main.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_SWITCH_BRANCH_FOR_AGENTSwitch the active branch for agent operations.

Input Parameters

string
required
Branch ID to activate; use “main” for the main branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_TYPECHECK_CODEType-check source content with Framer’s TypeScript service and return diagnostics.

Input Parameters

string
required
Source code to type-check.
string
required
Code file name used in diagnostics.
string
Optional type-check session ID used to reuse provider state.
object
TypeScript compiler options; additional protocol options are preserved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_UPDATE_ENUM_CASEUpdate a case in an enum field or enum variable.

Input Parameters

string
required
ID of the enum case to update.
string
required
EnumField field ID or EnumVariable variable ID.
string
required
Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
object
required
Enum case attributes to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_UPLOAD_FILEUpload one file asset to Framer.

Input Parameters

string
required
File asset to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_UPLOAD_FILESUpload multiple file assets to Framer.

Input Parameters

array
required
File assets to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_UPLOAD_IMAGEUpload one image to Framer without inserting it on the canvas.

Input Parameters

string
required
Image to upload without inserting it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRAMER_UPLOAD_IMAGESUpload multiple images to Framer without inserting them on the canvas.

Input Parameters

array
required
Images to upload without inserting them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not