> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Framer

> Framer is a website builder and design platform whose Server API supports project publishing, CMS, localization, canvas, asset, code, and agent workflows.

![Framer logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/framer.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=980136e374d585c816c21453a53f6509)

* **Category:** website & app building
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 157
* **Triggers:** 0
* **Slug:** `FRAMER`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Collection Fields
>
> **Slug:** `FRAMER_ADD_COLLECTION_FIELDS`
>
> Create or update typed field definitions in a CMS collection.
>
> #### Input Parameters
>
> **fields** `array` *required*
>
> Typed fields to create or update; include id for updates and omit it for creates.
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Collection Items
>
> **Slug:** `FRAMER_ADD_COLLECTION_ITEMS`
>
> Create or update CMS collection items with typed, tagged field values.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> Items to create or update; use id for updates and slug for creates.
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Component Instance
>
> **Slug:** `FRAMER_ADD_COMPONENT_INSTANCE`
>
> Insert a component instance by component module URL.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Framer component module URL.
>
> **parent\_id** `string`
>
> Optional parent node ID; omit to use Framer's current selection context.
>
> **attributes** `object`
>
> Optional editable component-instance attributes, including controls and layout values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Detached Component Layers
>
> **Slug:** `FRAMER_ADD_DETACHED_COMPONENT_LAYERS`
>
> Insert 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
>
> **url** `string` *required*
>
> Framer component module URL.
>
> **layout** `boolean`
>
> Whether to insert as a layout block and match breakpoints.
>
> **attributes** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Enum Case
>
> **Slug:** `FRAMER_ADD_ENUM_CASE`
>
> Add a case to an enum field or enum variable.
>
> #### Input Parameters
>
> **enum\_id** `string` *required*
>
> EnumField field ID or EnumVariable variable ID.
>
> **parent\_id** `string` *required*
>
> Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
>
> **attributes** `object` *required*
>
> Enum case attributes to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Image
>
> **Slug:** `FRAMER_ADD_IMAGE`
>
> Upload one image and insert it using the current editor selection/context. This action does not accept a target page.
>
> #### Input Parameters
>
> **image** `string` *required*
>
> Image to upload and insert on the canvas.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Images
>
> **Slug:** `FRAMER_ADD_IMAGES`
>
> Upload and insert multiple images using the current editor selection/context. This action does not accept a target page.
>
> #### Input Parameters
>
> **images** `array` *required*
>
> Images to upload and insert on the canvas.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Managed Collection Items
>
> **Slug:** `FRAMER_ADD_MANAGED_COLLECTION_ITEMS`
>
> Add or synchronize managed CMS items with typed, tagged field values and stable external IDs.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> Managed items to add or synchronize by stable external ID.
>
> **collection\_id** `string` *required*
>
> Managed CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Redirects
>
> **Slug:** `FRAMER_ADD_REDIRECTS`
>
> Create project redirects, or update existing redirects by including their IDs; all changes take effect on a subsequent publish.
>
> #### Input Parameters
>
> **redirects** `array` *required*
>
> Redirects to create, or existing redirects to update by ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add SVG
>
> **Slug:** `FRAMER_ADD_SVG`
>
> Insert an SVG on the canvas or replace the selected SVG.
>
> #### Input Parameters
>
> **svg** `string` *required*
>
> Serialized SVG markup to insert.
>
> **name** `string`
>
> Optional name for the inserted SVG layer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Text
>
> **Slug:** `FRAMER_ADD_TEXT`
>
> Insert text using the current editor selection/context. This action does not accept a target page.
>
> #### Input Parameters
>
> **tag** `string ("h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p")`
>
> Optional semantic HTML tag for the inserted text.
>
> **text** `string` *required*
>
> Plain text content to insert.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Apply Agent Changes
>
> **Slug:** `FRAMER_APPLY_AGENT_CHANGES`
>
> Execute Framer's agent command DSL on a project page.
>
> #### Input Parameters
>
> **dsl** `string` *required*
>
> Agent command DSL to execute.
>
> **page\_path** `string`
>
> Page route on which to apply the commands.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clone Design Page
>
> **Slug:** `FRAMER_CLONE_DESIGN_PAGE`
>
> Clone a design page by node ID, optionally requesting a name.
>
> #### Input Parameters
>
> **options** `object`
>
> Optional naming settings for the cloned page.
>
> **page\_id** `string` *required*
>
> ID of the DesignPageNode to clone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clone Node
>
> **Slug:** `FRAMER_CLONE_NODE`
>
> Clone a node by ID.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID to clone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clone Web Page
>
> **Slug:** `FRAMER_CLONE_WEB_PAGE`
>
> Clone a web page by node ID, optionally requesting a route path.
>
> #### Input Parameters
>
> **options** `object`
>
> Optional route settings for the cloned page.
>
> **page\_id** `string` *required*
>
> ID of the WebPageNode to clone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Branch
>
> **Slug:** `FRAMER_CREATE_BRANCH`
>
> Create 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
>
> **title** `string`
>
> Human-readable branch title.
>
> **base\_branch\_id** `string`
>
> Branch to use as the base; omit to use the active branch.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Branch For Agent
>
> **Slug:** `FRAMER_CREATE_BRANCH_FOR_AGENT`
>
> Create an agent branch from the active branch and switch to it.
>
> #### Input Parameters
>
> **title** `string`
>
> Human-readable branch title.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Code File
>
> **Slug:** `FRAMER_CREATE_CODE_FILE`
>
> Create a Framer code file with initial source content.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Initial source code for the file.
>
> **name** `string` *required*
>
> Name for the new code file.
>
> **edit\_via\_plugin** `boolean`
>
> Whether plugin tooling should edit the new file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Collection
>
> **Slug:** `FRAMER_CREATE_COLLECTION`
>
> Create a user-owned CMS collection in the connected Framer project.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable name for the new CMS collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Color Style
>
> **Slug:** `FRAMER_CREATE_COLOR_STYLE`
>
> Create a reusable color style in the connected Framer project.
>
> #### Input Parameters
>
> **dark** `string`
>
> Optional dark-appearance color, or null.
>
> **name** `string`
>
> Color style name; use slashes to create asset folders.
>
> **path** `string`
>
> Alternative hierarchical asset path for the style.
>
> **light** `string` *required*
>
> Light-appearance color in a Framer-supported CSS format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Component Node
>
> **Slug:** `FRAMER_CREATE_COMPONENT_NODE`
>
> Create a smart component node with a name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name for the new smart component.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Design Page
>
> **Slug:** `FRAMER_CREATE_DESIGN_PAGE`
>
> Create a design page.
>
> #### Input Parameters
>
> **page\_name** `string` *required*
>
> Name of the design page to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Frame Node
>
> **Slug:** `FRAMER_CREATE_FRAME_NODE`
>
> Create a frame node, optionally below a parent.
>
> #### Input Parameters
>
> **parent\_id** `string`
>
> Parent canvas node ID, or null to create at the canvas root.
>
> **attributes** `object` *required*
>
> Initial editable frame attributes; omitted fields use Framer defaults.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Locale
>
> **Slug:** `FRAMER_CREATE_LOCALE`
>
> Create a project locale.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable name for the new locale.
>
> **slug** `string`
>
> URL slug for the locale.
>
> **draft** `boolean`
>
> Whether the locale starts in draft state.
>
> **region** `string`
>
> Optional ISO region code for the locale.
>
> **language** `string` *required*
>
> BCP 47 language code, such as en or fr.
>
> **fallback\_locale\_id** `string`
>
> Existing locale ID to use when a translation is unavailable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Managed Collection
>
> **Slug:** `FRAMER_CREATE_MANAGED_COLLECTION`
>
> Create a plugin-managed CMS collection in the connected project.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable managed collection name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Text Node
>
> **Slug:** `FRAMER_CREATE_TEXT_NODE`
>
> Create a text node, optionally below a parent.
>
> #### Input Parameters
>
> **parent\_id** `string`
>
> Parent canvas node ID, or null to create at the canvas root.
>
> **attributes** `object` *required*
>
> Initial editable text-node attributes; omitted fields use Framer defaults.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Text Style
>
> **Slug:** `FRAMER_CREATE_TEXT_STYLE`
>
> Create a reusable text style in the connected Framer project.
>
> #### Input Parameters
>
> **attributes** `object` *required*
>
> Text style attributes accepted by Framer SDK 5.1.0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Web Page
>
> **Slug:** `FRAMER_CREATE_WEB_PAGE`
>
> Create a web page at a route path.
>
> #### Input Parameters
>
> **page\_path** `string` *required*
>
> Route path for the new web page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Branch
>
> **Slug:** `FRAMER_DELETE_BRANCH`
>
> Delete an explicit project branch, switching to its base if active.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Branch For Agent
>
> **Slug:** `FRAMER_DELETE_BRANCH_FOR_AGENT`
>
> Delete a branch in the agent workflow.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deploy
>
> **Slug:** `FRAMER_DEPLOY`
>
> Promote an existing Framer deployment to explicit domains or to the project's configured production domains.
>
> #### Input Parameters
>
> **domains** `array`
>
> Domain names to receive this deployment; omit to use the project's configured domains.
>
> **deployment\_id** `string` *required*
>
> Deployment ID returned by publish or list deployments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export SVG
>
> **Slug:** `FRAMER_EXPORT_SVG`
>
> Export a node as serialized SVG through Framer's dedicated WebSocket side channel.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Flatten Component Instance For Agent
>
> **Slug:** `FRAMER_FLATTEN_COMPONENT_INSTANCE_FOR_AGENT`
>
> Replace a component instance with editable local layers.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the component instance to flatten.
>
> **page\_path** `string`
>
> Page route containing the instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Active Branch
>
> **Slug:** `FRAMER_GET_ACTIVE_BRANCH`
>
> Get the branch currently active for the Framer editor and API session, including its base, contributor state, and creator metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Active Branch For Agent
>
> **Slug:** `FRAMER_GET_ACTIVE_BRANCH_FOR_AGENT`
>
> Get metadata for the branch active in the Framer agent session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent Context
>
> **Slug:** `FRAMER_GET_AGENT_CONTEXT`
>
> Get dynamic project context for Framer's agent command and query APIs.
>
> #### Input Parameters
>
> **page\_path** `string`
>
> Page route used to scope the agent context.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent System Prompt
>
> **Slug:** `FRAMER_GET_AGENT_SYSTEM_PROMPT`
>
> Get Framer's static agent prompt, including its command and project-query DSL references.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ancestors For Agent
>
> **Slug:** `FRAMER_GET_ANCESTORS_FOR_AGENT`
>
> Get a node's ancestors from its parent through the page root.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose ancestor chain should be returned.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Branch Changes
>
> **Slug:** `FRAMER_GET_BRANCH_CHANGES`
>
> Get semantic changes in a branch relative to its base branch.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID whose changes should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Branch Changes For Agent
>
> **Slug:** `FRAMER_GET_BRANCH_CHANGES_FOR_AGENT`
>
> Get a summarized changelog for a project branch relative to its base.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID whose summarized changes to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Branches
>
> **Slug:** `FRAMER_GET_BRANCHES`
>
> Return every project branch, a selected set, or one branch by passing zero, many, or one branch ID.
>
> #### Input Parameters
>
> **branch\_ids** `array`
>
> Branch IDs to return; pass one ID for one branch, or an empty list to return all branches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Branches For Agent
>
> **Slug:** `FRAMER_GET_BRANCHES_FOR_AGENT`
>
> List project branches available to the Framer agent session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Canvas Root
>
> **Slug:** `FRAMER_GET_CANVAS_ROOT`
>
> Get the root node of the current canvas.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Change Contributors
>
> **Slug:** `FRAMER_GET_CHANGE_CONTRIBUTORS`
>
> Get contributors who changed the project in an optional version range.
>
> #### Input Parameters
>
> **to\_version** `integer`
>
> Last project version to include.
>
> **from\_version** `integer`
>
> First project version to include.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Changed Paths
>
> **Slug:** `FRAMER_GET_CHANGED_PATHS`
>
> Get page paths added, removed, or modified between the active project version and its previously published version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Children
>
> **Slug:** `FRAMER_GET_CHILDREN`
>
> Get a node's canvas children.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Code File
>
> **Slug:** `FRAMER_GET_CODE_FILE`
>
> Get one Framer code file by ID or project-relative path.
>
> #### Input Parameters
>
> **id\_or\_path** `string` *required*
>
> Code file ID or project-relative path.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Code Files
>
> **Slug:** `FRAMER_GET_CODE_FILES`
>
> List code files and their current contents in the connected Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Code File Version Content
>
> **Slug:** `FRAMER_GET_CODE_FILE_VERSION_CONTENT`
>
> Get the source content of a saved Framer code file version.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> Code file ID captured from a CodeFileVersion object.
>
> **version\_id** `string` *required*
>
> Version ID captured from a CodeFileVersion object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Code File Versions
>
> **Slug:** `FRAMER_GET_CODE_FILE_VERSIONS`
>
> List saved versions of a Framer code file.
>
> #### Input Parameters
>
> **code\_file\_id** `string` *required*
>
> Code file ID captured from a CodeFile object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection
>
> **Slug:** `FRAMER_GET_COLLECTION`
>
> Get one CMS collection by its node ID.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection Fields
>
> **Slug:** `FRAMER_GET_COLLECTION_FIELDS`
>
> List all field definitions in a CMS collection, including dividers.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection Items
>
> **Slug:** `FRAMER_GET_COLLECTION_ITEMS`
>
> List items and typed field values in a CMS collection.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collections
>
> **Slug:** `FRAMER_GET_COLLECTIONS`
>
> List managed and user-owned CMS collections in the connected Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Color Style
>
> **Slug:** `FRAMER_GET_COLOR_STYLE`
>
> Get one reusable color style by ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Color style node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Color Styles
>
> **Slug:** `FRAMER_GET_COLOR_STYLES`
>
> List reusable color styles in the connected Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `FRAMER_GET_CURRENT_USER`
>
> Get the Framer user whose identity and project permissions are represented by the connected project API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Code
>
> **Slug:** `FRAMER_GET_CUSTOM_CODE`
>
> Get custom HTML and disabled state for all four project document injection locations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Default Locale
>
> **Slug:** `FRAMER_GET_DEFAULT_LOCALE`
>
> Get the project's default locale.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Deployment
>
> **Slug:** `FRAMER_GET_DEPLOYMENT`
>
> Get the latest status snapshot, timestamps, creator, preview URL, and failure stage for one Framer deployment.
>
> #### Input Parameters
>
> **deployment\_id** `string` *required*
>
> Deployment ID returned by publish or list deployments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Deployment Issues
>
> **Slug:** `FRAMER_GET_DEPLOYMENT_ISSUES`
>
> Get optimization warnings and errors for a Framer deployment, including related node IDs when available.
>
> #### Input Parameters
>
> **deployment\_id** `string` *required*
>
> Deployment ID returned by publish or list deployments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Descendant References Of Types For Agent
>
> **Slug:** `FRAMER_GET_DESCENDANT_REFERENCES_OF_TYPES_FOR_AGENT`
>
> Get matching style or token nodes referenced by descendants.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose descendant references should be searched.
>
> **types** `array` *required*
>
> Provider-defined referenced node type names to match.
>
> **page\_path** `string`
>
> Page route to search; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Descendants Of Types For Agent
>
> **Slug:** `FRAMER_GET_DESCENDANTS_OF_TYPES_FOR_AGENT`
>
> Get descendants of a node matching provider-defined node types.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose descendants should be searched.
>
> **types** `array` *required*
>
> Provider-defined node type names to match.
>
> **page\_path** `string`
>
> Page route to search; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Font
>
> **Slug:** `FRAMER_GET_FONT`
>
> Get one available font variant by family, weight, and style.
>
> #### Input Parameters
>
> **family** `string` *required*
>
> Font family name; matching is case-insensitive.
>
> **attributes** `object`
>
> Optional weight and style match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Fonts
>
> **Slug:** `FRAMER_GET_FONTS`
>
> List individual font files and variants available to the Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ground Node For Agent
>
> **Slug:** `FRAMER_GET_GROUND_NODE_FOR_AGENT`
>
> Get the top-level canvas node containing a node.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose top-level canvas node should be returned.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Locale Languages
>
> **Slug:** `FRAMER_GET_LOCALE_LANGUAGES`
>
> List valid locale language codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Locale Regions
>
> **Slug:** `FRAMER_GET_LOCALE_REGIONS`
>
> List valid region codes for a language.
>
> #### Input Parameters
>
> **language** `string` *required*
>
> BCP 47 language code, such as en or fr.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Locales
>
> **Slug:** `FRAMER_GET_LOCALES`
>
> List configured non-default locales.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Localization Groups
>
> **Slug:** `FRAMER_GET_LOCALIZATION_GROUPS`
>
> Get localization groups, optionally filtered by IDs or type.
>
> #### Input Parameters
>
> **group\_ids** `array`
>
> Localization group IDs to include; omit to include all matching groups.
>
> **group\_type** `string ("collection" | "collection-item" | "component" | "page" | "settings" | "template")`
>
> Localization group type to include.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Managed Collection Fields
>
> **Slug:** `FRAMER_GET_MANAGED_COLLECTION_FIELDS`
>
> List supported fields in a plugin-managed Framer CMS collection.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> Collection ID captured from a ManagedCollection object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Managed Collection Item IDs
>
> **Slug:** `FRAMER_GET_MANAGED_COLLECTION_ITEM_IDS`
>
> List external item IDs in a plugin-managed CMS collection.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> Managed CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Managed Collections
>
> **Slug:** `FRAMER_GET_MANAGED_COLLECTIONS`
>
> List plugin-managed CMS collections available to the connected API session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Node
>
> **Slug:** `FRAMER_GET_NODE`
>
> Get a project node by ID.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Node For Agent
>
> **Slug:** `FRAMER_GET_NODE_FOR_AGENT`
>
> Get one serialized Framer node and its children by ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node to retrieve.
>
> **page\_path** `string`
>
> Page route containing the node.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nodes For Agent
>
> **Slug:** `FRAMER_GET_NODES_FOR_AGENT`
>
> Get serialized Framer nodes and their children by ID.
>
> #### Input Parameters
>
> **ids** `array` *required*
>
> Node IDs to retrieve in input order.
>
> **page\_path** `string`
>
> Page route containing the nodes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nodes Of Types For Agent
>
> **Slug:** `FRAMER_GET_NODES_OF_TYPES_FOR_AGENT`
>
> Get all nodes of selected types on a Framer page without children.
>
> #### Input Parameters
>
> **types** `array` *required*
>
> Node type names to match.
>
> **page\_path** `string`
>
> Page route to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nodes With Attribute
>
> **Slug:** `FRAMER_GET_NODES_WITH_ATTRIBUTE`
>
> Get project nodes whose node type supports an attribute, whether or not it is set.
>
> #### Input Parameters
>
> **attribute** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nodes With Attribute Set
>
> **Slug:** `FRAMER_GET_NODES_WITH_ATTRIBUTE_SET`
>
> Get project nodes where a supported attribute has a non-null value.
>
> #### Input Parameters
>
> **attribute** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nodes With Type
>
> **Slug:** `FRAMER_GET_NODES_WITH_TYPE`
>
> Get all nodes of a known class, optionally below a parent node.
>
> #### Input Parameters
>
> **node\_type** `string ("FrameNode" | "TextNode" | "SVGNode" | "ComponentInstanceNode" | "WebPageNode" | "DesignPageNode" | "ComponentNode" | "ShapeContainerNode" | "PathNode" | "ShapeGroupNode" | "BooleanShapeNode")` *required*
>
> Concrete Framer node class to return.
>
> **parent\_node\_id** `string`
>
> Parent node ID to search below, or null to search the whole project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Parent
>
> **Slug:** `FRAMER_GET_PARENT`
>
> Get a node's parent.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Parent Node For Agent
>
> **Slug:** `FRAMER_GET_PARENT_NODE_FOR_AGENT`
>
> Get the direct parent of a node.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose direct parent should be returned.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Info
>
> **Slug:** `FRAMER_GET_PROJECT_INFO`
>
> Get the connected Framer project's current identity and legacy migration ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Publish Info
>
> **Slug:** `FRAMER_GET_PUBLISH_INFO`
>
> Get the connected project's current staging and production publication URLs, deployment times, and optimization states.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rect
>
> **Slug:** `FRAMER_GET_RECT`
>
> Get the bounding rectangle of a Framer node.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rect For Agent
>
> **Slug:** `FRAMER_GET_RECT_FOR_AGENT`
>
> Get a node's rounded canvas rectangle.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose rounded canvas rectangle is needed.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Redirects
>
> **Slug:** `FRAMER_GET_REDIRECTS`
>
> List the project's redirects, including source and destination paths and locale expansion behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Scope Node For Agent
>
> **Slug:** `FRAMER_GET_SCOPE_NODE_FOR_AGENT`
>
> Get the enclosing page or component scope for a node.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node whose enclosing scope should be returned.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Text for Node
>
> **Slug:** `FRAMER_GET_TEXT_FOR_NODE`
>
> Get the plain-text content of a text node by ID.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> ID of the TextNode whose plain text to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Text Style
>
> **Slug:** `FRAMER_GET_TEXT_STYLE`
>
> Get one reusable text style by ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Text style node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Text Styles
>
> **Slug:** `FRAMER_GET_TEXT_STYLES`
>
> List reusable text styles in the connected Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Unpublished Page Changes
>
> **Slug:** `FRAMER_GET_UNPUBLISHED_PAGE_CHANGES`
>
> List web pages added, updated, or removed since the active branch was last published.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Vector Set Items
>
> **Slug:** `FRAMER_GET_VECTOR_SET_ITEMS`
>
> List vector items in one Framer vector set.
>
> #### Input Parameters
>
> **vector\_set\_id** `string` *required*
>
> Vector set ID returned by Get Vector Sets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Vector Set Item Variables
>
> **Slug:** `FRAMER_GET_VECTOR_SET_ITEM_VARIABLES`
>
> List customizable variables for one Framer vector-set item.
>
> #### Input Parameters
>
> **module\_id** `string` *required*
>
> Module ID returned with the vector set item.
>
> **vector\_set\_item\_id** `string` *required*
>
> Vector set item ID returned by Get Vector Set Items.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Vector Sets
>
> **Slug:** `FRAMER_GET_VECTOR_SETS`
>
> List vector icon sets available to the connected Framer project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Join Branch
>
> **Slug:** `FRAMER_JOIN_BRANCH`
>
> Join an explicit project branch as a contributor.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to join as a contributor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Join Branch For Agent
>
> **Slug:** `FRAMER_JOIN_BRANCH_FOR_AGENT`
>
> Join a branch as a contributor for agent editing.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to join as a contributor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Leave Branch
>
> **Slug:** `FRAMER_LEAVE_BRANCH`
>
> Leave an explicit project branch as a contributor.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to leave as a contributor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Leave Branch For Agent
>
> **Slug:** `FRAMER_LEAVE_BRANCH_FOR_AGENT`
>
> Leave a branch as a contributor.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to leave as a contributor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lint Code
>
> **Slug:** `FRAMER_LINT_CODE`
>
> Deprecated Framer lint operation retained for compatibility; SDK 5.1.0 documents it as a no-op.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Source code to pass to the deprecated linter.
>
> **severity** `string ("error" | "warning")` *required*
>
> Severity for the removed forbid-browser-apis rule.
>
> **file\_name** `string` *required*
>
> Code file name used in diagnostics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Components For Agent
>
> **Slug:** `FRAMER_LIST_COMPONENTS_FOR_AGENT`
>
> List project, external, and additional components available to the agent.
>
> #### Input Parameters
>
> **page\_path** `string`
>
> Page route used to scope the component catalog.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Deployments
>
> **Slug:** `FRAMER_LIST_DEPLOYMENTS`
>
> List one cursor-controlled page of deployments for the active Framer branch, returning at most 30 records.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum deployments to return in this page (1-30).
>
> **cursor** `string`
>
> Opaque continuation cursor returned by the preceding call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Icon Sets For Agent
>
> **Slug:** `FRAMER_LIST_ICON_SETS_FOR_AGENT`
>
> List project, external, and additional icon sets available to the agent on the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Localization Groups Next
>
> **Slug:** `FRAMER_LIST_LOCALIZATION_GROUPS_NEXT`
>
> List all localization groups from Framer's session-bound iterator. The action consumes every cursor on one WebSocket connection and returns the complete list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Make External Component Local For Agent
>
> **Slug:** `FRAMER_MAKE_EXTERNAL_COMPONENT_LOCAL_FOR_AGENT`
>
> Copy an external component into the project and optionally replace all instances.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the external component instance.
>
> **page\_path** `string`
>
> Page route containing the component.
>
> **replace\_all** `boolean`
>
> Whether to replace every instance after provider confirmation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge Branch
>
> **Slug:** `FRAMER_MERGE_BRANCH`
>
> Merge an explicit source branch into its base or a compatible target.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Source branch ID to merge.
>
> **target\_branch\_id** `string`
>
> Target branch ID; omit to merge into the source branch base.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge Branch For Agent
>
> **Slug:** `FRAMER_MERGE_BRANCH_FOR_AGENT`
>
> Merge the active agent branch into its base or an explicit target, then switch to the target.
>
> #### Input Parameters
>
> **target\_branch\_id** `string`
>
> Merge target branch ID; use "main" for the main branch or omit to use the active branch base.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Paginate For Agent
>
> **Slug:** `FRAMER_PAGINATE_FOR_AGENT`
>
> Paginate a complete item list to completion within one Framer WebSocket session and return all results.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> Complete items to paginate within this action invocation.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish
>
> **Slug:** `FRAMER_PUBLISH`
>
> Publish the active Framer branch and return the resulting deployment plus its preview or staging hostnames.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish For Agent
>
> **Slug:** `FRAMER_PUBLISH_FOR_AGENT`
>
> Run an agent publish operation, including production deployment when requested.
>
> #### Input Parameters
>
> **input** `object`
>
> Action-discriminated input defined by Framer's agent system prompt.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Analytics For Agent
>
> **Slug:** `FRAMER_QUERY_ANALYTICS_FOR_AGENT`
>
> Run an analytics query over an ISO date range.
>
> #### Input Parameters
>
> **to** `string`
>
> Optional analytics range end as an ISO string.
>
> **query** `string` *required*
>
> Analytics query to execute.
>
> **from\_date** `string` *required*
>
> Inclusive analytics range start as an ISO string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Images For Agent
>
> **Slug:** `FRAMER_QUERY_IMAGES_FOR_AGENT`
>
> Search Framer's agent image sources and return candidate images.
>
> #### Input Parameters
>
> **input** `object` *required*
>
> Image source and search options from the agent system prompt.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Component Controls For Agent
>
> **Slug:** `FRAMER_READ_COMPONENT_CONTROLS_FOR_AGENT`
>
> Read provider-defined controls for project components on the active page.
>
> #### Input Parameters
>
> **component\_ids** `array` *required*
>
> Component IDs whose provider-defined controls to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Icon Set Controls For Agent
>
> **Slug:** `FRAMER_READ_ICON_SET_CONTROLS_FOR_AGENT`
>
> Read provider-defined controls for icon sets on the active page.
>
> #### Input Parameters
>
> **icon\_set\_ids** `array` *required*
>
> Icon-set IDs whose provider-defined controls to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Icons For Agent
>
> **Slug:** `FRAMER_READ_ICONS_FOR_AGENT`
>
> Read exact icon names from an icon set on the active page.
>
> #### Input Parameters
>
> **icon\_set\_id** `string` *required*
>
> Icon-set ID whose exact icon names to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Layout Template Controls For Agent
>
> **Slug:** `FRAMER_READ_LAYOUT_TEMPLATE_CONTROLS_FOR_AGENT`
>
> Read provider-defined controls for layout templates on the active page.
>
> #### Input Parameters
>
> **layout\_template\_ids** `array` *required*
>
> Layout-template IDs whose provider-defined controls to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Project For Agent
>
> **Slug:** `FRAMER_READ_PROJECT_FOR_AGENT`
>
> Execute agent query objects against project state.
>
> #### Input Parameters
>
> **queries** `array` *required*
>
> Agent query objects using the exact DSL returned by Framer's agent system prompt.
>
> **page\_path** `string`
>
> Page route used to scope the project query.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Read Shader Controls For Agent
>
> **Slug:** `FRAMER_READ_SHADER_CONTROLS_FOR_AGENT`
>
> Read provider-defined controls for shaders on the active page.
>
> #### Input Parameters
>
> **shader\_names** `array` *required*
>
> Shader names whose provider-defined controls to read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Code File
>
> **Slug:** `FRAMER_REMOVE_CODE_FILE`
>
> Remove a Framer code file.
>
> #### Input Parameters
>
> **code\_file\_id** `string` *required*
>
> Code file ID captured from a CodeFile object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Collection Fields
>
> **Slug:** `FRAMER_REMOVE_COLLECTION_FIELDS`
>
> Remove one or more fields from a CMS collection.
>
> #### Input Parameters
>
> **field\_ids** `array` *required*
>
> IDs of collection fields to remove.
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Collection Items
>
> **Slug:** `FRAMER_REMOVE_COLLECTION_ITEMS`
>
> Remove CMS collection items by item or node ID.
>
> #### Input Parameters
>
> **item\_ids** `array` *required*
>
> CMS item or node IDs to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Color Style
>
> **Slug:** `FRAMER_REMOVE_COLOR_STYLE`
>
> Remove a reusable Framer color style.
>
> #### Input Parameters
>
> **color\_style\_id** `string` *required*
>
> Style ID captured from a ColorStyle object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Enum Case
>
> **Slug:** `FRAMER_REMOVE_ENUM_CASE`
>
> Remove a case from an enum field or enum variable.
>
> #### Input Parameters
>
> **case\_id** `string` *required*
>
> ID of the enum case to remove.
>
> **enum\_id** `string` *required*
>
> EnumField field ID or EnumVariable variable ID.
>
> **parent\_id** `string` *required*
>
> Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Managed Collection Items
>
> **Slug:** `FRAMER_REMOVE_MANAGED_COLLECTION_ITEMS`
>
> Remove items from a managed CMS collection by external item ID.
>
> #### Input Parameters
>
> **item\_ids** `array` *required*
>
> External IDs of managed collection items to remove.
>
> **collection\_id** `string` *required*
>
> Managed CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Nodes
>
> **Slug:** `FRAMER_REMOVE_NODES`
>
> Remove one or more canvas nodes by ID; pass a one-element list to remove one node.
>
> #### Input Parameters
>
> **node\_ids** `array` *required*
>
> One or more canvas node IDs to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Redirects
>
> **Slug:** `FRAMER_REMOVE_REDIRECTS`
>
> Remove project redirects by ID; unknown IDs are ignored by Framer.
>
> #### Input Parameters
>
> **redirect\_ids** `array` *required*
>
> Redirect IDs to remove; Framer ignores IDs that do not exist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Text Style
>
> **Slug:** `FRAMER_REMOVE_TEXT_STYLE`
>
> Remove a reusable Framer text style.
>
> #### Input Parameters
>
> **text\_style\_id** `string` *required*
>
> Style ID captured from a TextStyle object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename Branch
>
> **Slug:** `FRAMER_RENAME_BRANCH`
>
> Rename an explicit project branch.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> New human-readable branch title.
>
> **branch\_id** `string` *required*
>
> Branch ID to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename Branch For Agent
>
> **Slug:** `FRAMER_RENAME_BRANCH_FOR_AGENT`
>
> Rename a branch for the agent workflow.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> New human-readable branch title.
>
> **branch\_id** `string` *required*
>
> Branch ID to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename Code File
>
> **Slug:** `FRAMER_RENAME_CODE_FILE`
>
> Rename a Framer code file.
>
> #### Input Parameters
>
> **new\_name** `string` *required*
>
> New code file name.
>
> **code\_file\_id** `string` *required*
>
> Code file ID captured from a CodeFile object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace Text For Agent
>
> **Slug:** `FRAMER_REPLACE_TEXT_FOR_AGENT`
>
> Replace exact text within one Framer text node.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the text node to update.
>
> **page\_path** `string`
>
> Page route containing the text node.
>
> **search\_text** `string` *required*
>
> Exact text to find in the node.
>
> **replace\_text** `string` *required*
>
> Text to substitute for each match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Screenshot Node
>
> **Slug:** `FRAMER_SCREENSHOT_NODE`
>
> Capture a node screenshot through Framer's dedicated WebSocket side channel.
>
> #### Input Parameters
>
> **clip** `object`
>
> Optional clipping rectangle in CSS pixels before scaling.
>
> **scale** `number`
>
> Pixel-density multiplier; Framer defaults to 1.
>
> **format** `string ("png" | "jpeg")`
>
> Image format; Framer defaults to png.
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> **quality** `integer`
>
> JPEG quality from 0 to 100; only applies to jpeg.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Serialize For Agent
>
> **Slug:** `FRAMER_SERIALIZE_FOR_AGENT`
>
> Serialize a node with optional depth, attribute, and ancestor filtering.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the node to serialize.
>
> **depth** `integer`
>
> Maximum descendant depth to include.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> **ancestor\_path** `boolean`
>
> Whether to include the node's ancestor path.
>
> **attribute\_filter** `array`
>
> Node attribute names to include in the serialization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Serialize Nodes For Agent
>
> **Slug:** `FRAMER_SERIALIZE_NODES_FOR_AGENT`
>
> Serialize multiple nodes with optional depth, attribute, and ancestor filtering.
>
> #### Input Parameters
>
> **ids** `array` *required*
>
> IDs of nodes to serialize in input order.
>
> **depth** `integer`
>
> Maximum descendant depth to include.
>
> **page\_path** `string`
>
> Page route to inspect; defaults to the active page.
>
> **ancestor\_path** `boolean`
>
> Whether to include each node's ancestor path.
>
> **attribute\_filter** `array`
>
> Node attribute names to include in each serialization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Code File Content
>
> **Slug:** `FRAMER_SET_CODE_FILE_CONTENT`
>
> Replace the source content of a Framer code file.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Complete source content to write to the code file.
>
> **code\_file\_id** `string` *required*
>
> Code file ID captured from a CodeFile object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Collection Field Order
>
> **Slug:** `FRAMER_SET_COLLECTION_FIELD_ORDER`
>
> Set the display order of fields in a CMS collection.
>
> #### Input Parameters
>
> **field\_ids** `array` *required*
>
> All collection field IDs in the desired display order.
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Collection Item Attributes
>
> **Slug:** `FRAMER_SET_COLLECTION_ITEM_ATTRIBUTES`
>
> Update one CMS item's slug, typed fields, locale status, or draft state.
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> CMS item or node ID to update.
>
> **attributes** `object` *required*
>
> Item attributes to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Collection Item Order
>
> **Slug:** `FRAMER_SET_COLLECTION_ITEM_ORDER`
>
> Set the item order in a CMS collection.
>
> #### Input Parameters
>
> **item\_ids** `array` *required*
>
> All CMS item IDs in the desired order.
>
> **collection\_id** `string` *required*
>
> CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Color Style Attributes
>
> **Slug:** `FRAMER_SET_COLOR_STYLE_ATTRIBUTES`
>
> Update selected attributes of a reusable Framer color style.
>
> #### Input Parameters
>
> **update** `object` *required*
>
> Color style attributes to update.
>
> **color\_style\_id** `string` *required*
>
> Style ID captured from a ColorStyle object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Custom Code
>
> **Slug:** `FRAMER_SET_CUSTOM_CODE`
>
> Set custom HTML at one Framer document injection location, or clear that location by passing null or omitting HTML.
>
> #### Input Parameters
>
> **html** `string`
>
> HTML to inject, or null to clear the selected location.
>
> **location** `string ("headStart" | "headEnd" | "bodyStart" | "bodyEnd")` *required*
>
> Document location where the custom HTML is injected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Enum Case Order
>
> **Slug:** `FRAMER_SET_ENUM_CASE_ORDER`
>
> Set the case order for an enum field or enum variable.
>
> #### Input Parameters
>
> **enum\_id** `string` *required*
>
> EnumField field ID or EnumVariable variable ID.
>
> **case\_ids** `array` *required*
>
> IDs of all enum cases in the desired order.
>
> **parent\_id** `string` *required*
>
> Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Localization Data
>
> **Slug:** `FRAMER_SET_LOCALIZATION_DATA`
>
> Set localized values and per-locale group status. The result includes per-value and per-group status update errors.
>
> #### Input Parameters
>
> **update** `object` *required*
>
> Localized values and group statuses keyed by source, group, and locale IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Managed Collection Fields
>
> **Slug:** `FRAMER_SET_MANAGED_COLLECTION_FIELDS`
>
> Replace and synchronize the typed field schema of a managed CMS collection.
>
> #### Input Parameters
>
> **fields** `array` *required*
>
> Complete managed field schema to synchronize.
>
> **collection\_id** `string` *required*
>
> Managed CMS collection node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Managed Collection Item Order
>
> **Slug:** `FRAMER_SET_MANAGED_COLLECTION_ITEM_ORDER`
>
> Set item order in a plugin-managed Framer CMS collection.
>
> #### Input Parameters
>
> **item\_ids** `array` *required*
>
> Managed item IDs in the desired order.
>
> **collection\_id** `string` *required*
>
> Collection ID captured from a ManagedCollection object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Node Attributes
>
> **Slug:** `FRAMER_SET_NODE_ATTRIBUTES`
>
> Patch editable attributes on a node. Only explicitly supplied attributes are sent.
>
> #### Input Parameters
>
> **node\_id** `string` *required*
>
> Framer canvas node ID.
>
> **attributes** `object` *required*
>
> Editable attributes supported by the target node class; omitted fields are unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Parent
>
> **Slug:** `FRAMER_SET_PARENT`
>
> Move a node to a new parent and optional child index.
>
> #### Input Parameters
>
> **index** `integer`
>
> Optional zero-based child position under the new parent.
>
> **node\_id** `string` *required*
>
> Node to move.
>
> **parent\_id** `string` *required*
>
> New parent node ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Redirect Order
>
> **Slug:** `FRAMER_SET_REDIRECT_ORDER`
>
> Set the evaluation and display order of project redirects; unknown redirect IDs are ignored.
>
> #### Input Parameters
>
> **redirect\_ids** `array` *required*
>
> Redirect IDs in the desired order; Framer ignores IDs that do not exist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Text
>
> **Slug:** `FRAMER_SET_TEXT`
>
> Set text on the current selection or insert it when appropriate.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Plain text to set on the current selection or insert when appropriate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Text Style Attributes
>
> **Slug:** `FRAMER_SET_TEXT_STYLE_ATTRIBUTES`
>
> Update selected attributes of a reusable Framer text style.
>
> #### Input Parameters
>
> **attributes** `object` *required*
>
> Text style attributes to update.
>
> **text\_style\_id** `string` *required*
>
> Style ID captured from a TextStyle object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Switch Branch
>
> **Slug:** `FRAMER_SWITCH_BRANCH`
>
> Switch the editor and subsequent edits to an explicit branch.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to activate; use "main" for main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Switch Branch For Agent
>
> **Slug:** `FRAMER_SWITCH_BRANCH_FOR_AGENT`
>
> Switch the active branch for agent operations.
>
> #### Input Parameters
>
> **branch\_id** `string` *required*
>
> Branch ID to activate; use "main" for the main branch.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Typecheck Code
>
> **Slug:** `FRAMER_TYPECHECK_CODE`
>
> Type-check source content with Framer's TypeScript service and return diagnostics.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Source code to type-check.
>
> **file\_name** `string` *required*
>
> Code file name used in diagnostics.
>
> **session\_id** `string`
>
> Optional type-check session ID used to reuse provider state.
>
> **compiler\_options** `object`
>
> TypeScript compiler options; additional protocol options are preserved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Enum Case
>
> **Slug:** `FRAMER_UPDATE_ENUM_CASE`
>
> Update a case in an enum field or enum variable.
>
> #### Input Parameters
>
> **case\_id** `string` *required*
>
> ID of the enum case to update.
>
> **enum\_id** `string` *required*
>
> EnumField field ID or EnumVariable variable ID.
>
> **parent\_id** `string` *required*
>
> Collection ID for an EnumField, or component/collection node ID for an EnumVariable.
>
> **attributes** `object` *required*
>
> Enum case attributes to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File
>
> **Slug:** `FRAMER_UPLOAD_FILE`
>
> Upload one file asset to Framer.
>
> #### Input Parameters
>
> **file** `string` *required*
>
> File asset to upload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Files
>
> **Slug:** `FRAMER_UPLOAD_FILES`
>
> Upload multiple file assets to Framer.
>
> #### Input Parameters
>
> **files** `array` *required*
>
> File assets to upload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Image
>
> **Slug:** `FRAMER_UPLOAD_IMAGE`
>
> Upload one image to Framer without inserting it on the canvas.
>
> #### Input Parameters
>
> **image** `string` *required*
>
> Image to upload without inserting it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Images
>
> **Slug:** `FRAMER_UPLOAD_IMAGES`
>
> Upload multiple images to Framer without inserting them on the canvas.
>
> #### Input Parameters
>
> **images** `array` *required*
>
> Images to upload without inserting them.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
