POST
/
schema_from_id
Get BRK Schema
curl --request POST \
  --url https://api.brx.ai/schema_from_id \
  --header 'Content-Type: application/json' \
  --header 'key: <api-key>' \
  --data '{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}'
{
  "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"
  }
}

Authorizations

​
key
string
header
required

Body

application/json

Request containing the BRK ID to fetch

The body is of type object.

Response

200
application/json

BRK schema response containing the complete schema definition

The response is of type object.