curl --request POST \
--url https://api.brx.ai/modify_brx \
--header 'Content-Type: application/json' \
--header 'key: <api-key>' \
--data '
{
"modifyBrxMode": "CREATE",
"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"
}
}
'{
"modifyBrxResponse": {
"httpResponse": {
"isError": false,
"statusMsg": "BRK created successfully",
"brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}
}
}Create BRK
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.
curl --request POST \
--url https://api.brx.ai/modify_brx \
--header 'Content-Type: application/json' \
--header 'key: <api-key>' \
--data '
{
"modifyBrxMode": "CREATE",
"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"
}
}
'{
"modifyBrxResponse": {
"httpResponse": {
"isError": false,
"statusMsg": "BRK created successfully",
"brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}
}
}Authorizations
Body
Modification request containing the operation type and relevant parameters
The type of modification to perform. CREATE creates a new BRK, UPDATE modifies an existing BRK, DELETE removes a BRK, CLONE creates a copy of an existing BRK, OP performs an operation on a BRK, TAG adds or removes a tag from a BRK, and CALL_ORDER modifies the execution order of BRK dependencies.
CREATE, UPDATE, DELETE, CLONE, OP, TAG, CALL_ORDER "CREATE"
The ID of the BRK to modify. Required for UPDATE, DELETE, CLONE, OP, TAG, and CALL_ORDER operations. For CREATE operations, a new ID will be generated if not provided.
"brk-12345678-90ab-cdef-1234-567890abcdef"
The complete BRK definition, including prompts, dependencies, and configuration parameters. Required for CREATE and UPDATE operations.
{
"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"
}
}
The schema definition for the BRK, including input fields and their types. Required for CREATE and UPDATE operations.
{
"schemaFields": {
"variable": {
"fieldValueDataType": "string",
"fieldValue": ""
}
},
"brxName": "Example BRK",
"brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}
Optional editor-specific JSON data for the BRK. This can include layout information, visual settings, and other editor-specific metadata.
{
"layout": {
"nodes": [
{
"id": "node1",
"position": { "x": 100, "y": 100 }
}
],
"edges": []
}
}
Optional configuration parameters for the BRK. This can include execution settings, model parameters, and other configuration options.
{
"maxTokens": 1000,
"temperature": 0.7,
"topP": 0.9
}
The type of operation to perform on the BRK. Required for OP operations.
"VALIDATE"
The tag to add or remove from the BRK. Required for TAG operations.
"production"
The tag operation to perform. PUSH adds a tag, PULL removes a tag. Required for TAG operations.
PUSH, PULL "PUSH"
Response
Modification response containing the result of the operation
Show child attributes
Show child attributes