{ "httpResponse": { "isError": false, "statusMsg": "BRK schema fetched successfully", "brkObject": "{\"brxId\":\"brk-12345678-90ab-cdef-1234-567890abcdef\",\"brxName\":\"Example BRK\",\"description\":\"An example BRK for documentation\",\"prompt\":{\"prompt\":{\"main\":\"This is the main prompt template with {{variable}}\"}},\"processParams\":{\"processType\":0},\"dependantBrxIds\":{\"main_brx_entry_schema\":\"brk-12345678-90ab-cdef-1234-567890abcdef\"}}", "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef" }}
{
"httpResponse": {
"isError": true,
"errorID": "forbidden",
"statusMsg": "You do not have permission to access this BRK"
}
}
{
"httpResponse": {
"isError": true,
"errorID": "not-found",
"statusMsg": "BRK with ID 'brk-12345678-90ab-cdef-1234-567890abcdef' not found"
}
}
{
"httpResponse": {
"isError": true,
"errorID": "server-error",
"statusMsg": "An unexpected error occurred while processing your request"
}
}
BRK Management
Get BRK Schema
Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.
{ "httpResponse": { "isError": false, "statusMsg": "BRK schema fetched successfully", "brkObject": "{\"brxId\":\"brk-12345678-90ab-cdef-1234-567890abcdef\",\"brxName\":\"Example BRK\",\"description\":\"An example BRK for documentation\",\"prompt\":{\"prompt\":{\"main\":\"This is the main prompt template with {{variable}}\"}},\"processParams\":{\"processType\":0},\"dependantBrxIds\":{\"main_brx_entry_schema\":\"brk-12345678-90ab-cdef-1234-567890abcdef\"}}", "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef" }}
{"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/get","slug":"/api-reference/endpoint/get","pageMetadata":{"title":"Get BRK Schema","openapi":"POST /schema_from_id","description":"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.","href":"/api-reference/endpoint/get"},"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: \"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get BRK Schema","openapi":"POST /schema_from_id","description":"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.","href":"/api-reference/endpoint/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/brx/5a0d712819755478/api-reference/openapi-components/compile-openapi.js"],"openApiReferenceData":{"operation":{"summary":"Get BRK Schema","description":"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.","operationId":"getBrkSchema","tags":["BRK Management"],"requestBody":"6a992a87-600c-4f4a-b158-52d3fb9ef46c","responses":{"200":"07a07ba9-5918-44bc-8756-1c2477669f8e","400":"10e3a792-b5cb-40e8-8872-5143612c80ac","401":"ebc90469-1463-45e2-aa53-335be6ab8699","403":"0e434859-1778-4a39-b785-4c0876231ce1","404":"63a3973a-186f-4635-aab1-929e5f8fcda8","500":"18dfb183-2e28-4a02-b3ed-f6f1ac8b2ebb"},"method":"post","type":"path","servers":["18cf3ade-0d79-48e3-92d5-0e2579146814","3a512524-cd39-479a-9b3a-ac0bd7b29a78"],"security":["578c54cb-bd39-4a1d-88d7-0076e067c7a7"],"path":"/schema_from_id","baseUrlOptions":["https://api.brx.ai","https://staging-api.brx.ai"],"title":"Get BRK Schema","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Request containing the BRK ID to fetch","required":true,"content":{"application/json":{"schema":{"type":"object","required":["brxId"],"properties":{"brxId":{"type":"string","description":"The unique identifier of the BRK to fetch","example":"brk-12345678-90ab-cdef-1234-567890abcdef","isRequired":true,"uniqueKey":"brxId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Simple":{"title":"Simple","value":{"brxId":"brk-12345678-90ab-cdef-1234-567890abcdef"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"07a07ba9-5918-44bc-8756-1c2477669f8e":{"description":"BRK schema response containing the complete schema definition","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","description":"Indicates whether the request resulted in an error","example":false,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"statusMsg":{"type":"string","description":"A message describing the status of the request","example":"BRK schema fetched successfully","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"},"brkObject":{"type":"string","description":"JSON string containing the complete BRK schema, including input fields, dependencies, and configuration parameters","example":"{\"brxId\":\"brk-12345678-90ab-cdef-1234-567890abcdef\",\"brxName\":\"Example BRK\",\"description\":\"An example BRK for documentation\",\"prompt\":{\"prompt\":{\"main\":\"This is the main prompt template with {{variable}}\"}},\"processParams\":{\"processType\":0},\"dependantBrxIds\":{\"main_brx_entry_schema\":\"brk-12345678-90ab-cdef-1234-567890abcdef\"}}","uniqueKey":"httpResponse.brkObject","typeLabel":"string"},"brxId":{"type":"string","description":"The ID of the BRK that was fetched","example":"brk-12345678-90ab-cdef-1234-567890abcdef","uniqueKey":"httpResponse.brxId","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Success":{"title":"Success","value":{"httpResponse":{"isError":false,"statusMsg":"BRK schema fetched successfully","brkObject":"{\"brxId\":\"brk-12345678-90ab-cdef-1234-567890abcdef\",\"brxName\":\"Example BRK\",\"description\":\"An example BRK for documentation\",\"prompt\":{\"prompt\":{\"main\":\"This is the main prompt template with {{variable}}\"}},\"processParams\":{\"processType\":0},\"dependantBrxIds\":{\"main_brx_entry_schema\":\"brk-12345678-90ab-cdef-1234-567890abcdef\"}}","brxId":"brk-12345678-90ab-cdef-1234-567890abcdef"}}}},"exampleType":"examples"}},"exampleType":"examples"},"10e3a792-b5cb-40e8-8872-5143612c80ac":{"description":"Bad Request - The request was malformed or missing required parameters","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","example":true,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"errorID":{"type":"string","example":"error-id","uniqueKey":"httpResponse.errorID","typeLabel":"string"},"statusMsg":{"type":"string","example":"Error message","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"MissingBrxId":{"title":"MissingBrxId","value":{"httpResponse":{"isError":true,"errorID":"bad-request","statusMsg":"Missing required parameter: brxId"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ebc90469-1463-45e2-aa53-335be6ab8699":{"description":"Unauthorized - Authentication credentials are missing or invalid","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","example":true,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"errorID":{"type":"string","example":"error-id","uniqueKey":"httpResponse.errorID","typeLabel":"string"},"statusMsg":{"type":"string","example":"Error message","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"InvalidApiKey":{"title":"InvalidApiKey","value":{"httpResponse":{"isError":true,"errorID":"unauthorized","statusMsg":"Invalid API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0e434859-1778-4a39-b785-4c0876231ce1":{"description":"Forbidden - The authenticated user does not have permission to access the requested BRK","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","example":true,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"errorID":{"type":"string","example":"error-id","uniqueKey":"httpResponse.errorID","typeLabel":"string"},"statusMsg":{"type":"string","example":"Error message","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"NoPermission":{"title":"NoPermission","value":{"httpResponse":{"isError":true,"errorID":"forbidden","statusMsg":"You do not have permission to access this BRK"}}}},"exampleType":"examples"}},"exampleType":"examples"},"63a3973a-186f-4635-aab1-929e5f8fcda8":{"description":"Not Found - The requested BRK does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","example":true,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"errorID":{"type":"string","example":"error-id","uniqueKey":"httpResponse.errorID","typeLabel":"string"},"statusMsg":{"type":"string","example":"Error message","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"BrkNotFound":{"title":"BrkNotFound","value":{"httpResponse":{"isError":true,"errorID":"not-found","statusMsg":"BRK with ID 'brk-12345678-90ab-cdef-1234-567890abcdef' not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"18dfb183-2e28-4a02-b3ed-f6f1ac8b2ebb":{"description":"Internal Server Error - An unexpected error occurred on the server","content":{"application/json":{"schema":{"type":"object","properties":{"httpResponse":{"type":"object","properties":{"isError":{"type":"boolean","example":true,"uniqueKey":"httpResponse.isError","typeLabel":"boolean"},"errorID":{"type":"string","example":"error-id","uniqueKey":"httpResponse.errorID","typeLabel":"string"},"statusMsg":{"type":"string","example":"Error message","uniqueKey":"httpResponse.statusMsg","typeLabel":"string"}},"uniqueKey":"httpResponse","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ServerError":{"title":"ServerError","value":{"httpResponse":{"isError":true,"errorID":"server-error","statusMsg":"An unexpected error occurred while processing your request"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"578c54cb-bd39-4a1d-88d7-0076e067c7a7":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"key","scopes":[]}}},"servers":{"18cf3ade-0d79-48e3-92d5-0e2579146814":{"url":"https://api.brx.ai","description":"Production API Server"},"3a512524-cd39-479a-9b3a-ac0bd7b29a78":{"url":"https://staging-api.brx.ai","description":"Staging API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"key","scopes":[]},"schema":{"title":"key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"brx","siteName":"DOCS","title":"Get BRK Schema - DOCS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:52:38.230Z","originalFileLocation":"api-reference/endpoint/get.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=\"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\">\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=\"Get BRK Schema - DOCS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\">\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/get\">\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+Management\u0026amp;title=Get+BRK+Schema\u0026amp;description=Fetches+a+BRK+schema+by+its+ID.+The+schema+contains+all+the+information+needed+to+initialize+and+execute+a+BRK%2C+including+input+fields%2C+dependencies%2C+and+config\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=35dc043307af88d2099499b2dae50bf725fe802781f34fbd4f02f1cb79919319\">\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=\"Get BRK Schema - DOCS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=BRK+Management\u0026amp;title=Get+BRK+Schema\u0026amp;description=Fetches+a+BRK+schema+by+its+ID.+The+schema+contains+all+the+information+needed+to+initialize+and+execute+a+BRK%2C+including+input+fields%2C+dependencies%2C+and+config\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=35dc043307af88d2099499b2dae50bf725fe802781f34fbd4f02f1cb79919319\">\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/get\">\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/get.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/get#webpage\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/get\",\"name\":\"Get BRK Schema\",\"description\":\"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\",\"dateModified\":\"2026-01-07T04:52:38.230Z\",\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"DOCS\",\"item\":\"https://docs.brx.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get BRK Schema\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brx.ai/api-reference/endpoint/get#apireference\",\"headline\":\"Get BRK Schema\",\"name\":\"Get BRK Schema\",\"description\":\"Fetches a BRK schema by its ID. The schema contains all the information needed to initialize and execute a BRK, including input fields, dependencies, and configuration parameters. This endpoint is typically used as the first step in executing a BRK, as you need the schema to properly initialize the BRK with the correct input fields.\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/get#webpage\"},\"dateModified\":\"2026-01-07T04:52:38.230Z\",\"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,"description":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","description":"Creates, updates, deletes, or clones a BRK. This versatile endpoint handles all BRK modification operations through the `modifyBrxMode` parameter. When creating or updating a BRK, you must provide the complete BRK definition, including prompts, dependencies, and configuration parameters. For deletion, you only need to provide the BRK ID. For cloning, you need to provide the source BRK ID.","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","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","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":"Get BRK Schema - DOCS","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"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","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}