lfx: compatibility declaration",id:"lfx-compatibility-declaration",level:2},{value:"bundles",id:"bundles",level:2},{value:"capabilities",id:"capabilities",level:2},{value:"Deferred fields",id:"deferred-fields",level:2},{value:"Pyproject alternative",id:"pyproject-alternative",level:2},{value:"Error codes raised against this manifest",id:"error-codes-raised-against-this-manifest",level:2},{value:"See also",id:"see-also",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return h||f("CH",!1),h.Code||f("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,o.jsxs)(t.p,{children:["This page is the reference for the ",(0,o.jsx)(t.code,{children:"extension.json"})," manifest the Langflow Extension loader consumes."]}),"\n",(0,o.jsxs)(t.p,{children:["The canonical JSON Schema lives at ",(0,o.jsx)(t.a,{href:"https://schemas.langflow.org/extension/v1.json",children:(0,o.jsx)(t.code,{children:"https://schemas.langflow.org/extension/v1.json"})})," and is generated from the Pydantic model at ",(0,o.jsx)(t.a,{href:"https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/extension/manifest.py",children:(0,o.jsx)(t.code,{children:"lfx.extension.manifest.ExtensionManifest"})}),"."]}),"\n",(0,o.jsx)(t.p,{children:"To export the live schema, run:"}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"lfx ",props:{style:{color:"#FFA657"}}},{content:"extension schema ",props:{style:{color:"#A5D6FF"}}},{content:"--output ",props:{style:{color:"#79C0FF"}}},{content:"extension.schema.json",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Use the ",(0,o.jsx)(t.code,{children:"$schema"})," reference in your manifest so editors can autocomplete and validate inline:"]}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "$schema"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"https://schemas.langflow.org/extension/v1.json"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "id"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"lfx-my-extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "version"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"0.1.0"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"My extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "lfx"',props:{style:{color:"#7EE787"}}},{content:": { ",props:{style:{color:"#C9D1D9"}}},{content:'"compat"',props:{style:{color:"#7EE787"}}},{content:": [",props:{style:{color:"#C9D1D9"}}},{content:'"1"',props:{style:{color:"#A5D6FF"}}},{content:"] },",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "bundles"',props:{style:{color:"#7EE787"}}},{content:": [{ ",props:{style:{color:"#C9D1D9"}}},{content:'"name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:", ",props:{style:{color:"#C9D1D9"}}},{content:'"path"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"components/my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:" }]",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:"}",props:{style:{color:"#C9D1D9"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,o.jsx)(t.h2,{id:"top-level-fields",children:"Top-level fields"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Field"}),(0,o.jsx)(t.th,{children:"Type"}),(0,o.jsx)(t.th,{children:"Required"}),(0,o.jsx)(t.th,{children:"Description"})]})}),(0,o.jsxs)(t.tbody,{children:[(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:(0,o.jsx)(t.code,{children:"id"})}),(0,o.jsx)(t.td,{children:"string"}),(0,o.jsx)(t.td,{children:"yes"}),(0,o.jsxs)(t.td,{children:["Globally-unique extension ID. Lowercase, hyphenated, starts with a letter, 2-64 chars. Convention: ",(0,o.jsx)(t.code,{children:"lfx-lfx: compatibility declaration",id:"lfx-compatibility-declaration",level:2},{value:"bundles",id:"bundles",level:2},{value:"capabilities",id:"capabilities",level:2},{value:"Deferred fields",id:"deferred-fields",level:2},{value:"Pyproject alternative",id:"pyproject-alternative",level:2},{value:"Error codes raised against this manifest",id:"error-codes-raised-against-this-manifest",level:2},{value:"See also",id:"see-also",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return h||f("CH",!1),h.Code||f("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,o.jsxs)(t.p,{children:["This page is the reference for the ",(0,o.jsx)(t.code,{children:"extension.json"})," manifest the Langflow Extension loader consumes."]}),"\n",(0,o.jsxs)(t.p,{children:["The canonical JSON Schema lives at ",(0,o.jsx)(t.a,{href:"https://schemas.langflow.org/extension/v1.json",children:(0,o.jsx)(t.code,{children:"https://schemas.langflow.org/extension/v1.json"})})," and is generated from the Pydantic model at ",(0,o.jsx)(t.a,{href:"https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/extension/manifest.py",children:(0,o.jsx)(t.code,{children:"lfx.extension.manifest.ExtensionManifest"})}),"."]}),"\n",(0,o.jsx)(t.p,{children:"To export the live schema, run:"}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"lfx ",props:{style:{color:"#FFA657"}}},{content:"extension schema ",props:{style:{color:"#A5D6FF"}}},{content:"--output ",props:{style:{color:"#79C0FF"}}},{content:"extension.schema.json",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Use the ",(0,o.jsx)(t.code,{children:"$schema"})," reference in your manifest so editors can autocomplete and validate inline:"]}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "$schema"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"https://schemas.langflow.org/extension/v1.json"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "id"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"lfx-my-extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "version"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"0.1.0"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"My extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "lfx"',props:{style:{color:"#7EE787"}}},{content:": { ",props:{style:{color:"#C9D1D9"}}},{content:'"compat"',props:{style:{color:"#7EE787"}}},{content:": [",props:{style:{color:"#C9D1D9"}}},{content:'"1"',props:{style:{color:"#A5D6FF"}}},{content:"] },",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "bundles"',props:{style:{color:"#7EE787"}}},{content:": [{ ",props:{style:{color:"#C9D1D9"}}},{content:'"name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:", ",props:{style:{color:"#C9D1D9"}}},{content:'"path"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"components/my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:" }]",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:"}",props:{style:{color:"#C9D1D9"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,o.jsx)(t.h2,{id:"top-level-fields",children:"Top-level fields"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Field"}),(0,o.jsx)(t.th,{children:"Type"}),(0,o.jsx)(t.th,{children:"Required"}),(0,o.jsx)(t.th,{children:"Description"})]})}),(0,o.jsxs)(t.tbody,{children:[(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:(0,o.jsx)(t.code,{children:"id"})}),(0,o.jsx)(t.td,{children:"string"}),(0,o.jsx)(t.td,{children:"yes"}),(0,o.jsxs)(t.td,{children:["Globally-unique extension ID. Lowercase, hyphenated, starts with a letter, 2-64 chars. Convention: ",(0,o.jsx)(t.code,{children:"lfx-lfx: compatibility declaration",id:"lfx-compatibility-declaration",level:2},{value:"bundles",id:"bundles",level:2},{value:"capabilities",id:"capabilities",level:2},{value:"Deferred fields",id:"deferred-fields",level:2},{value:"Pyproject alternative",id:"pyproject-alternative",level:2},{value:"Error codes raised against this manifest",id:"error-codes-raised-against-this-manifest",level:2},{value:"See also",id:"see-also",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return h||f("CH",!1),h.Code||f("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,o.jsxs)(t.p,{children:["This page is the reference for the ",(0,o.jsx)(t.code,{children:"extension.json"})," manifest the Langflow Extension loader consumes."]}),"\n",(0,o.jsxs)(t.p,{children:["The canonical JSON Schema lives at ",(0,o.jsx)(t.a,{href:"https://schemas.langflow.org/extension/v1.json",children:(0,o.jsx)(t.code,{children:"https://schemas.langflow.org/extension/v1.json"})})," and is generated from the Pydantic model at ",(0,o.jsx)(t.a,{href:"https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/extension/manifest.py",children:(0,o.jsx)(t.code,{children:"lfx.extension.manifest.ExtensionManifest"})}),"."]}),"\n",(0,o.jsx)(t.p,{children:"To export the live schema, run:"}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"lfx ",props:{style:{color:"#FFA657"}}},{content:"extension schema ",props:{style:{color:"#A5D6FF"}}},{content:"--output ",props:{style:{color:"#79C0FF"}}},{content:"extension.schema.json",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Use the ",(0,o.jsx)(t.code,{children:"$schema"})," reference in your manifest so editors can autocomplete and validate inline:"]}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "$schema"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"https://schemas.langflow.org/extension/v1.json"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "id"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"lfx-my-extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "version"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"0.1.0"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"My extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "lfx"',props:{style:{color:"#7EE787"}}},{content:": { ",props:{style:{color:"#C9D1D9"}}},{content:'"compat"',props:{style:{color:"#7EE787"}}},{content:": [",props:{style:{color:"#C9D1D9"}}},{content:'"1"',props:{style:{color:"#A5D6FF"}}},{content:"] },",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "bundles"',props:{style:{color:"#7EE787"}}},{content:": [{ ",props:{style:{color:"#C9D1D9"}}},{content:'"name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:", ",props:{style:{color:"#C9D1D9"}}},{content:'"path"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"components/my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:" }]",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:"}",props:{style:{color:"#C9D1D9"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,o.jsx)(t.h2,{id:"top-level-fields",children:"Top-level fields"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Field"}),(0,o.jsx)(t.th,{children:"Type"}),(0,o.jsx)(t.th,{children:"Required"}),(0,o.jsx)(t.th,{children:"Description"})]})}),(0,o.jsxs)(t.tbody,{children:[(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:(0,o.jsx)(t.code,{children:"id"})}),(0,o.jsx)(t.td,{children:"string"}),(0,o.jsx)(t.td,{children:"yes"}),(0,o.jsxs)(t.td,{children:["Globally-unique extension ID. Lowercase, hyphenated, starts with a letter, 2-64 chars. Convention: ",(0,o.jsx)(t.code,{children:"lfx-lfx: compatibility declaration",id:"lfx-compatibility-declaration",level:2},{value:"bundles",id:"bundles",level:2},{value:"capabilities",id:"capabilities",level:2},{value:"Deferred fields",id:"deferred-fields",level:2},{value:"Pyproject alternative",id:"pyproject-alternative",level:2},{value:"Error codes raised against this manifest",id:"error-codes-raised-against-this-manifest",level:2},{value:"See also",id:"see-also",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return h||f("CH",!1),h.Code||f("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,o.jsxs)(t.p,{children:["This page is the reference for the ",(0,o.jsx)(t.code,{children:"extension.json"})," manifest the Langflow Extension loader consumes."]}),"\n",(0,o.jsxs)(t.p,{children:["The canonical JSON Schema lives at ",(0,o.jsx)(t.a,{href:"https://schemas.langflow.org/extension/v1.json",children:(0,o.jsx)(t.code,{children:"https://schemas.langflow.org/extension/v1.json"})})," and is generated from the Pydantic model at ",(0,o.jsx)(t.a,{href:"https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/extension/manifest.py",children:(0,o.jsx)(t.code,{children:"lfx.extension.manifest.ExtensionManifest"})}),"."]}),"\n",(0,o.jsx)(t.p,{children:"To export the live schema, run:"}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"lfx ",props:{style:{color:"#FFA657"}}},{content:"extension schema ",props:{style:{color:"#A5D6FF"}}},{content:"--output ",props:{style:{color:"#79C0FF"}}},{content:"extension.schema.json",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Use the ",(0,o.jsx)(t.code,{children:"$schema"})," reference in your manifest so editors can autocomplete and validate inline:"]}),"\n",(0,o.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "$schema"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"https://schemas.langflow.org/extension/v1.json"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "id"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"lfx-my-extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "version"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"0.1.0"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"My extension"',props:{style:{color:"#A5D6FF"}}},{content:",",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "lfx"',props:{style:{color:"#7EE787"}}},{content:": { ",props:{style:{color:"#C9D1D9"}}},{content:'"compat"',props:{style:{color:"#7EE787"}}},{content:": [",props:{style:{color:"#C9D1D9"}}},{content:'"1"',props:{style:{color:"#A5D6FF"}}},{content:"] },",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:' "bundles"',props:{style:{color:"#7EE787"}}},{content:": [{ ",props:{style:{color:"#C9D1D9"}}},{content:'"name"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:", ",props:{style:{color:"#C9D1D9"}}},{content:'"path"',props:{style:{color:"#7EE787"}}},{content:": ",props:{style:{color:"#C9D1D9"}}},{content:'"components/my_bundle"',props:{style:{color:"#A5D6FF"}}},{content:" }]",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:"}",props:{style:{color:"#C9D1D9"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,o.jsx)(t.h2,{id:"top-level-fields",children:"Top-level fields"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Field"}),(0,o.jsx)(t.th,{children:"Type"}),(0,o.jsx)(t.th,{children:"Required"}),(0,o.jsx)(t.th,{children:"Description"})]})}),(0,o.jsxs)(t.tbody,{children:[(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:(0,o.jsx)(t.code,{children:"id"})}),(0,o.jsx)(t.td,{children:"string"}),(0,o.jsx)(t.td,{children:"yes"}),(0,o.jsxs)(t.td,{children:["Globally-unique extension ID. Lowercase, hyphenated, starts with a letter, 2-64 chars. Convention: ",(0,o.jsx)(t.code,{children:"lfx-The loader and validator both emit typed errors keyed by the manifest field that triggered them. The full code list is at lfx.extension.errors.ERROR_CODES; the codes most relevant when authoring a manifest are:
| Code | Cause |
|---|---|
manifest-invalid | Schema validation failed; the message names the field. |
manifest-not-found | No extension.json and no [tool.langflow.extension] section at the extension root. |
version-constraint-unsatisfied | lfx.compat does not include this Langflow's BUNDLE_​API_​VERSION. |
field-deferred-in-this-milestone | A reserved field was set to a non-null value. |
multi-bundle-deferred-in-this-milestone | bundles has more than one entry. |
path-escape | A bundles[].path resolves outside the manifest root (typically a symlink). |
bundle-path-not-found | bundles[].path does not exist or is not a directory. |
Run lfx extension validate <path> to see every error as a structured object with code, message, location, hint, and ref_url.