This endpoint executes a BRK with the provided input values. It processes the BRK, including any dependencies, and returns the result. The input values must match the schema of the BRK. You must have at least viewer permissions for the BRK to execute it.
The schemaValues object must match the schema of the BRK. You can use the Get BRK Schema endpoint to retrieve the schema.
The executionOptions object allows you to customize the execution behavior, such as the model to use and the sampling parameters.
The response includes the result of the execution, as well as metadata such as the execution time and token usage.
If the stream option is set to true, the response will be streamed as it is generated. This is useful for long-running executions.
The tokenUsage object provides information about the number of tokens used in the prompt, completion, and total. This can be useful for monitoring usage and costs.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"DOCS","colors":{"primary":"#36332e","light":"#f3e6cd","dark":"#36332e"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_dark_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=192d2c11b5bf54ed66b86c20da9ce796","dark":"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_light_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=6461c1ae8dfa7b34cfbb218805fd59c6"},"navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://app.brx.ai"}},"footer":{"socials":{"website":"https://brx.ai","x":"https://x.com/jandodev","github":"https://github.com/brx-ai","linkedin":"https://www.linkedin.com/company/brxai/"}},"navigation":{"global":{"anchors":[{"anchor":"Documentation","href":"https://predocs.brx.ai","icon":"book-open-cover"},{"anchor":"Community","href":"https://join.slack.com/t/brx-communityslack/shared_invite/zt-2vfndoyuv-FTxv0Wc2CzpfO6TH3VHpkg","icon":"slack"},{"anchor":"Github","href":"https://github.com/brx-ai","icon":"github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brx","hasAudioNarration":false,"actualSubdomain":"brx","customDomains":["docs.brx.ai"],"gitSource":{"type":"github","owner":"brx-ai","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":true,"issues":true},"entitlements":{},"buildId":"6ae92347abb6d0c12b814cd5:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Core Concepts","count":8},{"language":"default","tag":"BRK Management","count":3},{"language":"default","tag":"API Key Management","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Access Control","count":2},{"language":"default","tag":"BRK Execution","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"SDK Reference","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/execute","slug":"/api-reference/endpoint/execute","pageMetadata":{"title":"Execute BRK","api":"POST /execute_brx","description":"Executes a BRK with the provided input values","href":"/api-reference/endpoint/execute"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Executes a BRK with the provided input values\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This endpoint executes a BRK with the provided input values. It processes the BRK, including any dependencies, and returns the result. The input values must match the schema of the BRK. You must have at least viewer permissions for the BRK to execute it.`}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(ParamField,{body:`brxId`,type:`string`,required:true,id:`param-brx-id`,children:_jsx(_components.p,{children:`The ID of the BRK to execute`})}),`\n`,_jsx(ParamField,{body:`schemaValues`,type:`object`,required:true,id:`param-schema-values`,children:_jsx(_components.p,{children:`The input values for the BRK, matching its schema`})}),`\n`,_jsxs(ParamField,{body:`executionOptions`,type:`object`,optional:true,id:`param-execution-options`,children:[_jsx(_components.p,{children:`Optional execution options for the BRK`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`maxTokens`,type:`number`,optional:true,id:`param-max-tokens`,children:_jsx(_components.p,{children:`Maximum number of tokens to generate`})}),_jsx(ParamField,{body:`temperature`,type:`number`,optional:true,id:`param-temperature`,children:_jsx(_components.p,{children:`Temperature for sampling (0.0 to 1.0)`})}),_jsx(ParamField,{body:`topP`,type:`number`,optional:true,id:`param-top-p`,children:_jsx(_components.p,{children:`Top-p sampling parameter (0.0 to 1.0)`})}),_jsx(ParamField,{body:`model`,type:`string`,optional:true,id:`param-model`,children:_jsx(_components.p,{children:`The model to use for execution (e.g., “gpt-4”, “claude-3-opus”)`})}),_jsx(ParamField,{body:`stream`,type:`boolean`,optional:true,id:`param-stream`,children:_jsx(_components.p,{children:`Whether to stream the response`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"brk-12345678-90ab-cdef-1234-567890abcdef\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schemaValues\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"variable\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"example value\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"executionOptions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"maxTokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"temperature\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.7`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"topP\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.9`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gpt-4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stream\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`executeBrxResponse`,type:`object`,id:`param-execute-brx-response`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`httpResponse`,type:`object`,id:`param-http-response`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isError`,type:`boolean`,id:`param-is-error`,children:_jsx(_components.p,{children:`Indicates whether the request resulted in an error`})}),_jsx(ResponseField,{name:`statusMsg`,type:`string`,id:`param-status-msg`,children:_jsx(_components.p,{children:`A message describing the status of the request`})}),_jsx(ResponseField,{name:`result`,type:`string`,id:`param-result`,children:_jsx(_components.p,{children:`The result of the BRK execution`})}),_jsx(ResponseField,{name:`executionId`,type:`string`,id:`param-execution-id`,children:_jsx(_components.p,{children:`The unique identifier for this execution`})}),_jsx(ResponseField,{name:`executionTime`,type:`number`,id:`param-execution-time`,children:_jsx(_components.p,{children:`The time taken to execute the BRK in milliseconds`})}),_jsxs(ResponseField,{name:`tokenUsage`,type:`object`,id:`param-token-usage`,children:[_jsx(_components.p,{children:`Token usage information for the execution`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`prompt`,type:`number`,id:`param-prompt`,children:_jsx(_components.p,{children:`Number of tokens in the prompt`})}),_jsx(ResponseField,{name:`completion`,type:`number`,id:`param-completion`,children:_jsx(_components.p,{children:`Number of tokens in the completion`})}),_jsx(ResponseField,{name:`total`,type:`number`,id:`param-total`,children:_jsx(_components.p,{children:`Total number of tokens used`})})]})]})]})})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-response`,children:`Example Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"executeBrxResponse\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"httpResponse\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isError\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"statusMsg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BRK executed successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"result\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"This is the result of the BRK execution with the input value: example value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"executionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"exec-12345678-90ab-cdef-1234-567890abcdef\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"executionTime\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1234.56`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tokenUsage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"prompt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"completion\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`150`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsx(ResponseField,{name:`400`,type:`object`,id:`param-400`,children:_jsx(_components.p,{children:`Bad Request - The request was malformed or missing required parameters`})}),`\n`,_jsx(ResponseField,{name:`401`,type:`object`,id:`param-401`,children:_jsx(_components.p,{children:`Unauthorized - Authentication credentials are missing or invalid`})}),`\n`,_jsx(ResponseField,{name:`403`,type:`object`,id:`param-403`,children:_jsx(_components.p,{children:`Forbidden - The authenticated user does not have permission to execute the requested BRK`})}),`\n`,_jsx(ResponseField,{name:`404`,type:`object`,id:`param-404`,children:_jsx(_components.p,{children:`Not Found - The requested BRK does not exist`})}),`\n`,_jsx(ResponseField,{name:`429`,type:`object`,id:`param-429`,children:_jsx(_components.p,{children:`Too Many Requests - The user has exceeded the BRK execution rate limit`})}),`\n`,_jsx(ResponseField,{name:`500`,type:`object`,id:`param-500`,children:_jsx(_components.p,{children:`Internal Server Error - An unexpected error occurred on the server`})}),`\n`,_jsx(Heading,{level:`2`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`schemaValues`}),` object must match the schema of the BRK. You can use the `,_jsx(_components.a,{href:`/api-reference/endpoint/get`,children:`Get BRK Schema`}),` endpoint to retrieve the schema.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`executionOptions`}),` object allows you to customize the execution behavior, such as the model to use and the sampling parameters.`]}),`\n`,_jsx(_components.li,{children:`The response includes the result of the execution, as well as metadata such as the execution time and token usage.`}),`\n`,_jsxs(_components.li,{children:[`If the `,_jsx(_components.code,{children:`stream`}),` option is set to `,_jsx(_components.code,{children:`true`}),`, the response will be streamed as it is generated. This is useful for long-running executions.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`tokenUsage`}),` object provides information about the number of tokens used in the prompt, completion, and total. This can be useful for monitoring usage and costs.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Execute BRK","api":"POST /execute_brx","description":"Executes a BRK with the provided input values","href":"/api-reference/endpoint/execute"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[{"title":"Example Request","slug":"example-request","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"Example Response","slug":"example-response","depth":3,"children":[]}]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Execute BRK","path":"/execute_brx","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"brxId":[{"type":"string","description":"The ID of the BRK to execute","required":true}],"schemaValues":[{"type":"object","properties":{},"description":"The input values for the BRK, matching its schema","required":true}],"executionOptions":[{"type":"object","properties":{"maxTokens":[{"type":"number","description":"Maximum number of tokens to generate"}],"temperature":[{"type":"number","description":"Temperature for sampling (0.0 to 1.0)"}],"topP":[{"type":"number","description":"Top-p sampling parameter (0.0 to 1.0)"}],"model":[{"type":"string","description":"The model to use for execution (e.g., “gpt-4”, “claude-3-opus”)"}],"stream":[{"type":"boolean","description":"Whether to stream the response"}]},"description":"Optional execution options for the BRK"}]}}],"examples":{"example":{"value":{"brxId":"\u003cstring>","schemaValues":{},"executionOptions":{"maxTokens":123,"temperature":123,"topP":123,"model":"\u003cstring>","stream":true}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"400":[{"type":"object","properties":{},"description":"Bad Request - The request was malformed or missing required parameters"}],"401":[{"type":"object","properties":{},"description":"Unauthorized - Authentication credentials are missing or invalid"}],"403":[{"type":"object","properties":{},"description":"Forbidden - The authenticated user does not have permission to execute the requested BRK"}],"404":[{"type":"object","properties":{},"description":"Not Found - The requested BRK does not exist"}],"429":[{"type":"object","properties":{},"description":"Too Many Requests - The user has exceeded the BRK execution rate limit"}],"500":[{"type":"object","properties":{},"description":"Internal Server Error - An unexpected error occurred on the server"}],"executeBrxResponse":[{"type":"object","properties":{"httpResponse":[{"type":"object","properties":{"isError":[{"type":"boolean","description":"Indicates whether the request resulted in an error"}],"statusMsg":[{"type":"string","description":"A message describing the status of the request"}],"result":[{"type":"string","description":"The result of the BRK execution"}],"executionId":[{"type":"string","description":"The unique identifier for this execution"}],"executionTime":[{"type":"number","description":"The time taken to execute the BRK in milliseconds"}],"tokenUsage":[{"type":"object","properties":{"prompt":[{"type":"number","description":"Number of tokens in the prompt"}],"completion":[{"type":"number","description":"Number of tokens in the completion"}],"total":[{"type":"number","description":"Total number of tokens used"}]},"description":"Token usage information for the execution"}]}}]}}]}}],"examples":{"example":{"value":{"400":{},"401":{},"403":{},"404":{},"429":{},"500":{},"executeBrxResponse":{"httpResponse":{"isError":true,"statusMsg":"\u003cstring>","result":"\u003cstring>","executionId":"\u003cstring>","executionTime":123,"tokenUsage":{"prompt":123,"completion":123,"total":123}}}}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/brx/5a0d712819755478/api-reference/openapi-components/compile-openapi.js"],"subdomain":"brx","siteName":"DOCS","title":"Execute BRK - DOCS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:52:38.231Z","originalFileLocation":"api-reference/endpoint/execute.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Executes a BRK with the provided input values\">\u003cmeta data-mint-head name=\"application-name\" content=\"DOCS\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Execute BRK - DOCS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Executes a BRK with the provided input values\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DOCS\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brx.ai/api-reference/endpoint/execute\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=BRK+Execution\u0026amp;title=Execute+BRK\u0026amp;description=Executes+a+BRK+with+the+provided+input+values\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=7e62db4ac514d0dd0e73517def460783a12466d450f9e09f8a799239d495d4b8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Execute BRK - DOCS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Executes a BRK with the provided input values\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=BRK+Execution\u0026amp;title=Execute+BRK\u0026amp;description=Executes+a+BRK+with+the+provided+input+values\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=7e62db4ac514d0dd0e73517def460783a12466d450f9e09f8a799239d495d4b8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DOCS\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36332e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brx.ai/api-reference/endpoint/execute\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/execute.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brx.ai/#organization\",\"name\":\"DOCS\",\"url\":\"https://docs.brx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_dark_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=192d2c11b5bf54ed66b86c20da9ce796\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brx.ai#website\",\"name\":\"DOCS\",\"url\":\"https://docs.brx.ai\",\"publisher\":{\"@id\":\"https://docs.brx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/execute#webpage\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/execute\",\"name\":\"Execute BRK\",\"description\":\"Executes a BRK with the provided input values\",\"dateModified\":\"2026-01-07T04:52:38.231Z\",\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/execute#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/execute#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"DOCS\",\"item\":\"https://docs.brx.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Execute BRK\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/execute\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brx.ai/api-reference/endpoint/execute#apireference\",\"headline\":\"Execute BRK\",\"name\":\"Execute BRK\",\"description\":\"Executes a BRK with the provided input values\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/execute\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/execute#webpage\"},\"dateModified\":\"2026-01-07T04:52:38.231Z\",\"publisher\":{\"@id\":\"https://docs.brx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DOCS\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DOCS","nav":{"global":{"anchors":[{"anchor":"Documentation","href":"https://predocs.brx.ai","icon":"book-open-cover"},{"anchor":"Community","href":"https://join.slack.com/t/brx-communityslack/shared_invite/zt-2vfndoyuv-FTxv0Wc2CzpfO6TH3VHpkg","icon":"slack"},{"anchor":"Github","href":"https://github.com/brx-ai","icon":"github"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/Get Started/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":null,"href":"/api-reference/introduction"}]},{"group":"BRK Management","pages":[{"title":"Get BRK Schema","openapi":"POST /schema_from_id","href":"/api-reference/endpoint/get"},{"title":"Create BRK","openapi":"POST /modify_brx","href":"/api-reference/endpoint/create"},{"title":"List","href":"/api-reference/endpoint/list"},{"title":"List private","href":"/api-reference/endpoint/list-private"},{"title":"Get Raw BRK","api":"POST /raw_brx","description":"Retrieves the raw data for a BRK","href":"/api-reference/endpoint/raw"}]},{"group":"BRK Execution","pages":[{"title":"Execute BRK","api":"POST /execute_brx","href":"/api-reference/endpoint/execute"},{"title":"Validate BRK","api":"POST /validate_brx","description":"Validates a BRK to ensure it is properly structured","href":"/api-reference/endpoint/validate"}]},{"group":"Access Control","pages":[{"title":"Update BRK ACL","api":"POST /update_brx_acl","href":"/api-reference/endpoint/update-acl"},{"title":"Check BRK ACL","api":"POST /check_brx_acl","href":"/api-reference/endpoint/check-acl"}]},{"group":"API Key Management","pages":[{"title":"Generate API Key","api":"POST /generate_api_brx","href":"/api-reference/endpoint/generate-key"},{"title":"List API Keys","api":"POST /list_api_brx","href":"/api-reference/endpoint/list-keys"},{"title":"Delete API Key","api":"POST /delete_api_brx","href":"/api-reference/endpoint/delete-key"}]}]}]},"basePath":"","title":"Execute BRK - DOCS","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js"]}