> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Raw BRK

> Retrieves the raw data for a BRK

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

<ParamField body="brxId" type="string" required>
  The ID of the BRK to get raw data for
</ParamField>

### Example Request

```json theme={null}
{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}
```

## Response

<ResponseField name="brx" type="object">
  The complete BRK definition

  <Expandable title="properties">
    <ResponseField name="brxId" type="string">
      The unique identifier of the BRK
    </ResponseField>

    <ResponseField name="brxName" type="string">
      The name of the BRK
    </ResponseField>

    <ResponseField name="description" type="string">
      The description of the BRK
    </ResponseField>

    <ResponseField name="prompt" type="object">
      The prompt template for the BRK

      <Expandable title="properties">
        <ResponseField name="prompt" type="object">
          Map of prompt template names to template strings
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="processParams" type="object">
      Parameters for processing the BRK

      <Expandable title="properties">
        <ResponseField name="processType" type="number">
          The type of processing to perform
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="dependantBrxIds" type="object">
      Map of schema linker to BRK ID for dependencies
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="schema" type="object">
  The schema definition for the BRK

  <Expandable title="properties">
    <ResponseField name="schemaFields" type="object">
      Map of field names to field definitions

      <Expandable title="properties">
        <ResponseField name="fieldValueDataType" type="string">
          The data type of the field
        </ResponseField>

        <ResponseField name="fieldValue" type="string">
          The value of the field
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="brxName" type="string">
      The name of the BRK
    </ResponseField>

    <ResponseField name="brxId" type="string">
      The ID of the BRK
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="editorJSON" type="object">
  Editor-specific JSON data for the BRK
</ResponseField>

<ResponseField name="conf" type="object">
  Configuration parameters for the BRK
</ResponseField>

<ResponseField name="ops" type="object">
  Operations data for the BRK
</ResponseField>

### Example Response

```json theme={null}
{
  "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

<ResponseField name="400" type="object">
  Bad Request - The request was malformed or missing required parameters
</ResponseField>

<ResponseField name="401" type="object">
  Unauthorized - Authentication credentials are missing or invalid
</ResponseField>

<ResponseField name="403" type="object">
  Forbidden - The authenticated user does not have permission to access the raw data for the requested BRK
</ResponseField>

<ResponseField name="404" type="object">
  Not Found - The requested BRK does not exist
</ResponseField>

<ResponseField name="500" type="object">
  Internal Server Error - An unexpected error occurred on the server
</ResponseField>

## 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.