Skip to main content
POST
/
raw_brx
Get Raw BRK
curl --request POST \
  --url https://api.example.com/raw_brx \
  --header 'Content-Type: application/json' \
  --data '
{
  "brxId": "<string>"
}
'
{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "brx": {
    "brxId": "<string>",
    "brxName": "<string>",
    "description": "<string>",
    "prompt": {
      "prompt": {}
    },
    "processParams": {
      "processType": 123
    },
    "dependantBrxIds": {}
  },
  "schema": {
    "schemaFields": {
      "fieldValueDataType": "<string>",
      "fieldValue": "<string>"
    },
    "brxName": "<string>",
    "brxId": "<string>"
  },
  "editorJSON": {},
  "conf": {},
  "ops": {}
}
This endpoint retrieves the raw data for a BRK, including the complete BRK definition, schema, editor JSON, configuration, and operations. This endpoint is useful for advanced use cases where you need access to the internal structure of a BRK. You must have at least editor permissions for the BRK to access its raw data.

​
Request

​
brxId
string
required
The ID of the BRK to get raw data for

​
Example Request

{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}

​
Response

​
brx
object
The complete BRK definition
​
schema
object
The schema definition for the BRK
​
editorJSON
object
Editor-specific JSON data for the BRK
​
conf
object
Configuration parameters for the BRK
​
ops
object
Operations data for the BRK

​
Example Response

{
  "brx": {
    "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"
    }
  },
  "schema": {
    "schemaFields": {
      "variable": {
        "fieldValueDataType": "string",
        "fieldValue": ""
      }
    },
    "brxName": "Example BRK",
    "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
  },
  "editorJSON": {
    "layout": {
      "nodes": [
        {
          "id": "node1",
          "position": {
            "x": 100,
            "y": 100
          }
        }
      ],
      "edges": []
    }
  },
  "conf": {
    "maxTokens": 1000,
    "temperature": 0.7,
    "topP": 0.9
  },
  "ops": {
    "lastOperation": "UPDATE",
    "operationTimestamp": "2023-01-01T00:00:00.000Z"
  }
}

​
Error Codes

​
400
object
Bad Request - The request was malformed or missing required parameters
​
401
object
Unauthorized - Authentication credentials are missing or invalid
​
403
object
Forbidden - The authenticated user does not have permission to access the raw data for the requested BRK
​
404
object
Not Found - The requested BRK does not exist
​
500
object
Internal Server Error - An unexpected error occurred on the server

​
Notes

  • This endpoint returns the complete internal structure of a BRK, which can be useful for debugging or advanced use cases.
  • You must have at least editor permissions for the BRK to access its raw data.
  • The response includes the BRK definition, schema, editor JSON, configuration, and operations data.
  • The editorJSON field contains layout information and other editor-specific metadata.
  • The conf field contains configuration parameters for the BRK, such as model parameters.
  • The ops field contains information about operations performed on the BRK, such as the last operation and timestamp.