rakazo
6.2k
Get started

Framer

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

156 actionsAPI key

Connect Framer

What your bot can do in Framer

Looks up

  • Export SVGExport a node as serialized SVG through Framer's dedicated WebSocket side channel.
  • Get Active BranchGet the branch currently active for the Framer editor and API session, including its base, contributor state, and creator metadata.
  • Get Active Branch For AgentGet metadata for the branch active in the Framer agent session.
  • Get Agent ContextGet dynamic project context for Framer's agent command and query APIs.
  • Get Agent System PromptGet Framer's static agent prompt, including its command and project-query DSL references.
  • Get Ancestors For AgentGet a node's ancestors from its parent through the page root.
  • Get Branch ChangesGet semantic changes in a branch relative to its base branch.
  • Get Branch Changes For AgentGet a summarized changelog for a project branch relative to its base.
  • Get BranchesReturn every project branch, a selected set, or one branch by passing zero, many, or one branch ID.
  • Get Branches For AgentList project branches available to the Framer agent session.
Show 70 more
  • Get Canvas RootGet the root node of the current canvas.
  • Get Change ContributorsGet contributors who changed the project in an optional version range.
  • Get Changed PathsGet page paths added, removed, or modified between the active project version and its previously published version.
  • Get ChildrenGet a node's canvas children.
  • Get Code FileGet one Framer code file by ID or project-relative path.
  • Get Code File Version ContentGet the source content of a saved Framer code file version.
  • Get Code File VersionsList saved versions of a Framer code file.
  • Get Code FilesList code files and their current contents in the connected Framer project.
  • Get CollectionGet one CMS collection by its node ID.
  • Get Collection FieldsList all field definitions in a CMS collection, including dividers.
  • Get Collection ItemsList items and typed field values in a CMS collection.
  • Get CollectionsList managed and user-owned CMS collections in the connected Framer project.
  • Get Color StyleGet one reusable color style by ID.
  • Get Color StylesList reusable color styles in the connected Framer project.
  • Get Current UserGet the Framer user whose identity and project permissions are represented by the connected project API key.
  • Get Custom CodeGet custom HTML and disabled state for all four project document injection locations.
  • Get Default LocaleGet the project's default locale.
  • Get DeploymentGet the latest status snapshot, timestamps, creator, preview URL, and failure stage for one Framer deployment.
  • Get Deployment IssuesGet optimization warnings and errors for a Framer deployment, including related node IDs when available.
  • Get Descendant References Of Types For AgentGet matching style or token nodes referenced by descendants.
  • Get Descendants Of Types For AgentGet descendants of a node matching provider-defined node types.
  • Get FontGet one available font variant by family, weight, and style.
  • Get FontsList individual font files and variants available to the Framer project.
  • Get Ground Node For AgentGet the top-level canvas node containing a node.
  • Get Locale LanguagesList valid locale language codes.
  • Get Locale RegionsList valid region codes for a language.
  • Get LocalesList configured non-default locales.
  • Get Localization GroupsGet localization groups, optionally filtered by IDs or type.
  • Get Managed Collection FieldsList supported fields in a plugin-managed Framer CMS collection.
  • Get Managed Collection Item IDsList external item IDs in a plugin-managed CMS collection.
  • Get Managed CollectionsList plugin-managed CMS collections available to the connected API session.
  • Get NodeGet a project node by ID.
  • Get Node For AgentGet one serialized Framer node and its children by ID.
  • Get Nodes For AgentGet serialized Framer nodes and their children by ID.
  • Get Nodes Of Types For AgentGet all nodes of selected types on a Framer page without children.
  • Get Nodes With AttributeGet project nodes whose node type supports an attribute, whether or not it is set.
  • Get Nodes With Attribute SetGet project nodes where a supported attribute has a non-null value.
  • Get Nodes With TypeGet all nodes of a known class, optionally below a parent node.
  • Get ParentGet a node's parent.
  • Get Parent Node For AgentGet the direct parent of a node.
  • Get Project InfoGet the connected Framer project's current identity and legacy migration ID.
  • Get Publish InfoGet the connected project's current staging and production publication URLs, deployment times, and optimization states.
  • Get RectGet the bounding rectangle of a Framer node.
  • Get Rect For AgentGet a node's rounded canvas rectangle.
  • Get RedirectsList the project's redirects, including source and destination paths and locale expansion behavior.
  • Get Scope Node For AgentGet the enclosing page or component scope for a node.
  • Get Text for NodeGet the plain-text content of a text node by ID.
  • Get Text StyleGet one reusable text style by ID.
  • Get Text StylesList reusable text styles in the connected Framer project.
  • Get Unpublished Page ChangesList web pages added, updated, or removed since the active branch was last published.
  • Get Vector Set Item VariablesList customizable variables for one Framer vector-set item.
  • Get Vector Set ItemsList vector items in one Framer vector set.
  • Get Vector SetsList vector icon sets available to the connected Framer project.
  • List Components For AgentList project, external, and additional components available to the agent.
  • List DeploymentsList one cursor-controlled page of deployments for the active Framer branch, returning at most 30 records.
  • List Icon Sets For AgentList project, external, and additional icon sets available to the agent on the active page.
  • List Localization Groups NextList all localization groups from Framer's session-bound iterator.
  • Paginate For AgentPaginate a complete item list to completion within one Framer WebSocket session and return all results.
  • Query Analytics For AgentRun an analytics query over an ISO date range.
  • Query Images For AgentSearch Framer's agent image sources and return candidate images.
  • Read Component Controls For AgentRead provider-defined controls for project components on the active page.
  • Read Icon Set Controls For AgentRead provider-defined controls for icon sets on the active page.
  • Read Icons For AgentRead exact icon names from an icon set on the active page.
  • Read Layout Template Controls For AgentRead provider-defined controls for layout templates on the active page.
  • Read Project For AgentExecute agent query objects against project state.
  • Read Shader Controls For AgentRead provider-defined controls for shaders on the active page.
  • Screenshot NodeCapture a node screenshot through Framer's dedicated WebSocket side channel.
  • Serialize For AgentSerialize a node with optional depth, attribute, and ancestor filtering.
  • Serialize Nodes For AgentSerialize multiple nodes with optional depth, attribute, and ancestor filtering.
  • Typecheck CodeType-check source content with Framer's TypeScript service and return diagnostics.

Takes action

  • Add Collection FieldsCreate or update typed field definitions in a CMS collection.
  • Add Collection ItemsCreate or update CMS collection items with typed, tagged field values.
  • Add Component InstanceInsert a component instance by component module URL.
  • Add Detached Component LayersInsert editable component layers using the current editor selection/context without retaining an instance.
  • Add Enum CaseAdd a case to an enum field or enum variable.
  • Add ImageUpload one image and insert it using the current editor selection/context.
  • Add ImagesUpload and insert multiple images using the current editor selection/context.
  • Add Managed Collection ItemsAdd or synchronize managed CMS items with typed, tagged field values and stable external IDs.
  • Add RedirectsCreate project redirects, or update existing redirects by including their IDs.
  • Add SVGInsert an SVG on the canvas or replace the selected SVG.
Show 66 more
  • Add TextInsert text using the current editor selection/context.
  • Apply Agent ChangesExecute Framer's agent command DSL on a project page.
  • Clone Design PageClone a design page by node ID, optionally requesting a name.
  • Clone NodeClone a node by ID.
  • Clone Web PageClone a web page by node ID, optionally requesting a route path.
  • Create BranchCreate a Framer project branch from the active branch or a specified base, then switch the editor and API session to the new branch.
  • Create Branch For AgentCreate an agent branch from the active branch and switch to it.
  • Create Code FileCreate a Framer code file with initial source content.
  • Create CollectionCreate a user-owned CMS collection in the connected Framer project.
  • Create Color StyleCreate a reusable color style in the connected Framer project.
  • Create Component NodeCreate a smart component node with a name.
  • Create Design PageCreate a design page.
  • Create Frame NodeCreate a frame node, optionally below a parent.
  • Create LocaleCreate a project locale.
  • Create Managed CollectionCreate a plugin-managed CMS collection in the connected project.
  • Create Text NodeCreate a text node, optionally below a parent.
  • Create Text StyleCreate a reusable text style in the connected Framer project.
  • Create Web PageCreate a web page at a route path.
  • Delete BranchDelete an explicit project branch, switching to its base if active.
  • Delete Branch For AgentDelete a branch in the agent workflow.
  • DeployPromote an existing Framer deployment to explicit domains or to the project's configured production domains.
  • Flatten Component Instance For AgentReplace a component instance with editable local layers.
  • Join BranchJoin an explicit project branch as a contributor.
  • Join Branch For AgentJoin a branch as a contributor for agent editing.
  • Leave BranchLeave an explicit project branch as a contributor.
  • Leave Branch For AgentLeave a branch as a contributor.
  • Make External Component Local For AgentCopy an external component into the project and optionally replace all instances.
  • Merge BranchMerge an explicit source branch into its base or a compatible target.
  • Merge Branch For AgentMerge the active agent branch into its base or an explicit target, then switch to the target.
  • PublishPublish the active Framer branch and return the resulting deployment plus its preview or staging hostnames.
  • Publish For AgentRun an agent publish operation, including production deployment when requested.
  • Remove Code FileRemove a Framer code file.
  • Remove Collection FieldsRemove one or more fields from a CMS collection.
  • Remove Collection ItemsRemove CMS collection items by item or node ID.
  • Remove Color StyleRemove a reusable Framer color style.
  • Remove Enum CaseRemove a case from an enum field or enum variable.
  • Remove Managed Collection ItemsRemove items from a managed CMS collection by external item ID.
  • Remove NodesRemove one or more canvas nodes by ID.
  • Remove RedirectsRemove project redirects by ID.
  • Remove Text StyleRemove a reusable Framer text style.
  • Rename BranchRename an explicit project branch.
  • Rename Branch For AgentRename a branch for the agent workflow.
  • Rename Code FileRename a Framer code file.
  • Replace Text For AgentReplace exact text within one Framer text node.
  • Set Code File ContentReplace the source content of a Framer code file.
  • Set Collection Field OrderSet the display order of fields in a CMS collection.
  • Set Collection Item AttributesUpdate one CMS item's slug, typed fields, locale status, or draft state.
  • Set Collection Item OrderSet the item order in a CMS collection.
  • Set Color Style AttributesUpdate selected attributes of a reusable Framer color style.
  • Set Custom CodeSet custom HTML at one Framer document injection location, or clear that location by passing null or omitting HTML.
  • Set Enum Case OrderSet the case order for an enum field or enum variable.
  • Set Localization DataSet localized values and per-locale group status.
  • Set Managed Collection FieldsReplace and synchronize the typed field schema of a managed CMS collection.
  • Set Managed Collection Item OrderSet item order in a plugin-managed Framer CMS collection.
  • Set Node AttributesPatch editable attributes on a node.
  • Set ParentMove a node to a new parent and optional child index.
  • Set Redirect OrderSet the evaluation and display order of project redirects.
  • Set TextSet text on the current selection or insert it when appropriate.
  • Set Text Style AttributesUpdate selected attributes of a reusable Framer text style.
  • Switch BranchSwitch the editor and subsequent edits to an explicit branch.
  • Switch Branch For AgentSwitch the active branch for agent operations.
  • Update Enum CaseUpdate a case in an enum field or enum variable.
  • Upload FileUpload one file asset to Framer.
  • Upload FilesUpload multiple file assets to Framer.
  • Upload ImageUpload one image to Framer without inserting it on the canvas.
  • Upload ImagesUpload multiple images to Framer without inserting them on the canvas.

More design apps