Update Tool | BCTRL Docs

Update a custom tool definition. Changes apply to future tool use while existing tool call records remain available.

AuthorizationBearer

Use Bearer <api-key>.

idstringRequired

This endpoint expects an object.

spaceIdstringRequiredformat: "uuid"

descriptionstring or nullOptional<=2000 characters

executionobjectOptional

inputSchemaobjectOptional

metadataobject or nullOptional

namestringOptionalformat: "^[a-z_][a-z0-9_-]*$"1-64 characters

outputSchemaobjectOptional

statusenumOptional

Allowed values:

Default Response

createdAtstring

descriptionstring or null<=2000 characters

executionobject

idstringformat: "uuid"

inputSchemaobject

namestringformat: "^[a-z_][a-z0-9_-]*$"1-64 characters

outputSchemaobject

spaceIdstringformat: "uuid"

statusenum

Allowed values:

updatedAtstring

metadataobject or null

$	curl -X PATCH https://api.bctrl.ai/v2/tools/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
>	}'

1	{
2	"createdAt": "2024-06-01T12:00:00Z",
3	"description": "Tool for processing user data and generating reports.",
4	"execution": {
5	"auth": {
6	"type": "none"
7	},
8	"timeoutMs": 30000,
9	"type": "webhook",
10	"url": "https://hooks.example.com/tool-execution"
11	},
12	"id": "7e57d004-2b97-0e7a-b45f-5387367791cd",
13	"inputSchema": {},
14	"name": "data_processor",
15	"outputSchema": {},
16	"spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
17	"status": "enabled",
18	"updatedAt": "2024-06-10T15:30:00Z",
19	"metadata": {}
20	}