This endpoint validates a BRK to ensure it is properly structured and can be executed. It checks the BRK’s schema, prompt templates, dependencies, and configuration parameters. It does not execute the BRK, but only verifies that it is valid. You must have at least editor permissions for the BRK to validate it.
This endpoint is useful for checking if a BRK is valid before attempting to execute it.
The validation checks include:
Schema validation: Ensures that the BRK’s schema is properly structured and all required fields are present.
Prompt template validation: Ensures that all variables used in prompt templates are defined in the schema.
Dependency validation: Ensures that all referenced BRKs exist and are accessible.
Configuration validation: Ensures that all configuration parameters are valid.
The response includes detailed validation results for each component of the BRK, including any errors that were found.
A BRK is considered valid only if all components are valid (i.e., isValid is true for all components).
{"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/validate","slug":"/api-reference/endpoint/validate","pageMetadata":{"title":"Validate BRK","api":"POST /validate_brx","description":"Validates a BRK to ensure it is properly structured","href":"/api-reference/endpoint/validate"},"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: \"Validates a BRK to ensure it is properly structured\"\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={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 validates a BRK to ensure it is properly structured and can be executed. It checks the BRK’s schema, prompt templates, dependencies, and configuration parameters. It does not execute the BRK, but only verifies that it is valid. You must have at least editor permissions for the BRK to validate 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 validate`})}),`\n`,_jsx(Heading,{level:`3`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,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:`3`,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\"`})]}),`\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:`validateBrxResponse`,type:`object`,id:`param-validate-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:`isValid`,type:`boolean`,id:`param-is-valid`,children:_jsx(_components.p,{children:`Indicates whether the BRK is valid`})}),_jsxs(ResponseField,{name:`validationResults`,type:`object`,id:`param-validation-results`,children:[_jsx(_components.p,{children:`Detailed validation results for each component of the BRK`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`schema`,type:`object`,id:`param-schema`,children:[_jsx(_components.p,{children:`Validation results for the BRK schema`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isValid`,type:`boolean`,id:`param-is-valid-1`,children:_jsx(_components.p,{children:`Indicates whether the schema is valid`})}),_jsx(ResponseField,{name:`errors`,type:`array`,id:`param-errors`,children:_jsx(_components.p,{children:`Array of schema validation errors`})})]})]}),_jsxs(ResponseField,{name:`prompt`,type:`object`,id:`param-prompt`,children:[_jsx(_components.p,{children:`Validation results for the BRK prompt templates`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isValid`,type:`boolean`,id:`param-is-valid-2`,children:_jsx(_components.p,{children:`Indicates whether the prompt templates are valid`})}),_jsx(ResponseField,{name:`errors`,type:`array`,id:`param-errors-1`,children:_jsx(_components.p,{children:`Array of prompt template validation errors`})})]})]}),_jsxs(ResponseField,{name:`dependencies`,type:`object`,id:`param-dependencies`,children:[_jsx(_components.p,{children:`Validation results for the BRK dependencies`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isValid`,type:`boolean`,id:`param-is-valid-3`,children:_jsx(_components.p,{children:`Indicates whether the dependencies are valid`})}),_jsx(ResponseField,{name:`errors`,type:`array`,id:`param-errors-2`,children:_jsx(_components.p,{children:`Array of dependency validation errors`})})]})]}),_jsxs(ResponseField,{name:`configuration`,type:`object`,id:`param-configuration`,children:[_jsx(_components.p,{children:`Validation results for the BRK configuration parameters`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isValid`,type:`boolean`,id:`param-is-valid-4`,children:_jsx(_components.p,{children:`Indicates whether the configuration parameters are valid`})}),_jsx(ResponseField,{name:`errors`,type:`array`,id:`param-errors-3`,children:_jsx(_components.p,{children:`Array of configuration parameter validation errors`})})]})]})]})]})]})})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-response-valid-brk`,children:`Example Response (Valid BRK)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,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:`27`,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:` \"validateBrxResponse\"`}),_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 validated 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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"validationResults\"`}),_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:` \"schema\"`}),_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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_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:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dependencies\"`}),_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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"configuration\"`}),_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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_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:`3`,id:`example-response-invalid-brk`,children:`Example Response (Invalid BRK)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`31`,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:`31`,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:` \"validateBrxResponse\"`}),_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 validation failed\"`}),_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:` \"isValid\"`}),_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:` \"validationResults\"`}),_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:` \"schema\"`}),_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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_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:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isValid\"`}),_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:` \"errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Prompt template contains undefined variable: {{undefined_variable}}\"`})}),`\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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dependencies\"`}),_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:` \"isValid\"`}),_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:` \"errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Dependency 'main_brx_entry_schema' references a non-existent BRK: brk-abcdef12-3456-7890-abcd-ef1234567890\"`})}),`\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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"configuration\"`}),_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:` \"isValid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"errors\"`}),_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`,_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 validate 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:`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`,_jsx(_components.li,{children:`This endpoint is useful for checking if a BRK is valid before attempting to execute it.`}),`\n`,_jsxs(_components.li,{children:[`The validation checks include:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Schema validation: Ensures that the BRK’s schema is properly structured and all required fields are present.`}),`\n`,_jsx(_components.li,{children:`Prompt template validation: Ensures that all variables used in prompt templates are defined in the schema.`}),`\n`,_jsx(_components.li,{children:`Dependency validation: Ensures that all referenced BRKs exist and are accessible.`}),`\n`,_jsx(_components.li,{children:`Configuration validation: Ensures that all configuration parameters are valid.`}),`\n`]}),`\n`]}),`\n`,_jsx(_components.li,{children:`The response includes detailed validation results for each component of the BRK, including any errors that were found.`}),`\n`,_jsxs(_components.li,{children:[`A BRK is considered valid only if all components are valid (i.e., `,_jsx(_components.code,{children:`isValid`}),` is `,_jsx(_components.code,{children:`true`}),` for all components).`]}),`\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":"Validate BRK","api":"POST /validate_brx","description":"Validates a BRK to ensure it is properly structured","href":"/api-reference/endpoint/validate"}}},"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 (Valid BRK)","slug":"example-response-valid-brk","depth":3,"children":[]},{"title":"Example Response (Invalid BRK)","slug":"example-response-invalid-brk","depth":3,"children":[]}]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Validate BRK","path":"/validate_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 validate","required":true}]}}],"examples":{"example":{"value":{"brxId":"\u003cstring>"}}}}}},"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 validate the requested BRK"}],"404":[{"type":"object","properties":{},"description":"Not Found - The requested BRK does not exist"}],"500":[{"type":"object","properties":{},"description":"Internal Server Error - An unexpected error occurred on the server"}],"validateBrxResponse":[{"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"}],"isValid":[{"type":"boolean","description":"Indicates whether the BRK is valid"}],"validationResults":[{"type":"object","properties":{"schema":[{"type":"object","properties":{"isValid":[{"type":"boolean","description":"Indicates whether the schema is valid"}],"errors":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of schema validation errors"}]},"description":"Validation results for the BRK schema"}],"prompt":[{"type":"object","properties":{"isValid":[{"type":"boolean","description":"Indicates whether the prompt templates are valid"}],"errors":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of prompt template validation errors"}]},"description":"Validation results for the BRK prompt templates"}],"dependencies":[{"type":"object","properties":{"isValid":[{"type":"boolean","description":"Indicates whether the dependencies are valid"}],"errors":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of dependency validation errors"}]},"description":"Validation results for the BRK dependencies"}],"configuration":[{"type":"object","properties":{"isValid":[{"type":"boolean","description":"Indicates whether the configuration parameters are valid"}],"errors":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of configuration parameter validation errors"}]},"description":"Validation results for the BRK configuration parameters"}]},"description":"Detailed validation results for each component of the BRK"}]}}]}}]}}],"examples":{"example":{"value":{"400":{},"401":{},"403":{},"404":{},"500":{},"validateBrxResponse":{"httpResponse":{"isError":true,"statusMsg":"\u003cstring>","isValid":true,"validationResults":{"schema":{"isValid":true,"errors":[{}]},"prompt":{"isValid":true,"errors":[{}]},"dependencies":{"isValid":true,"errors":[{}]},"configuration":{"isValid":true,"errors":[{}]}}}}}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/brx/5a0d712819755478/api-reference/openapi-components/compile-openapi.js"],"subdomain":"brx","siteName":"DOCS","title":"Validate BRK - DOCS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:52:38.682Z","originalFileLocation":"api-reference/endpoint/validate.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=\"Validates a BRK to ensure it is properly structured\">\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=\"Validate BRK - DOCS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Validates a BRK to ensure it is properly structured\">\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/validate\">\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=Validate+BRK\u0026amp;description=Validates+a+BRK+to+ensure+it+is+properly+structured\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=8f6af32963a5d528ae09b5664c11b3ee7e1da81ad992d9c26071c8e0a2f0ba1b\">\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=\"Validate BRK - DOCS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validates a BRK to ensure it is properly structured\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=BRK+Execution\u0026amp;title=Validate+BRK\u0026amp;description=Validates+a+BRK+to+ensure+it+is+properly+structured\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=8f6af32963a5d528ae09b5664c11b3ee7e1da81ad992d9c26071c8e0a2f0ba1b\">\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/validate\">\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/validate.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/validate#webpage\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/validate\",\"name\":\"Validate BRK\",\"description\":\"Validates a BRK to ensure it is properly structured\",\"dateModified\":\"2026-01-07T04:52:38.682Z\",\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/validate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/validate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"BRK Execution\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/execute\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Validate BRK\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/validate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brx.ai/api-reference/endpoint/validate#apireference\",\"headline\":\"Validate BRK\",\"name\":\"Validate BRK\",\"description\":\"Validates a BRK to ensure it is properly structured\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/validate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/validate#webpage\"},\"dateModified\":\"2026-01-07T04:52:38.682Z\",\"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","href":"/api-reference/endpoint/raw"}]},{"group":"BRK Execution","pages":[{"title":"Execute BRK","api":"POST /execute_brx","description":"Executes a BRK with the provided input values","href":"/api-reference/endpoint/execute"},{"title":"Validate BRK","api":"POST /validate_brx","href":"/api-reference/endpoint/validate"}]},{"group":"Access Control","pages":[{"title":"Update BRK ACL","api":"POST /update_brx_acl","description":"Updates the access control list for a BRK","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":"Validate 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"]}