POST
/
modify_brx
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

key
string
header
required

Body

application/json

Modification request containing the operation type and relevant parameters

The body is of type object.

Response

Modification response containing the result of the operation

The response is of type object.