Get Tool | BCTRL Docs

curl https://api.bctrl.ai/v1/spaces/id/tools/toolId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

1	{
2	"createdAt": "2024-06-01T12:00:00Z",
3	"description": "This tool fetches the latest weather data for a given location.",
4	"enabled": true,
5	"execution": {
6	"auth": {
7	"type": "hmac",
8	"secretId": "weather-api-secret-123"
9	},
10	"timeoutMs": 30000,
11	"type": "webhook",
12	"url": "https://hooks.bctrl.ai/tools/weather-fetch"
13	},
14	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
15	"inputSchema": {
16	"type": "object",
17	"properties": {
18	"location": {
19	"type": "string",
20	"description": "City name or coordinates for weather lookup"
21	},
22	"units": {
23	"type": "string",
24	"enum": [
25	"metric",
26	"imperial"
27	],
28	"description": "Units for temperature"
29	}
30	},
31	"required": [
32	"location"
33	]
34	},
35	"name": "weather_fetcher",
36	"outputSchema": {
37	"type": "object",
38	"properties": {
39	"temperature": {
40	"type": "number",
41	"description": "Current temperature"
42	},
43	"condition": {
44	"type": "string",
45	"description": "Weather condition description"
46	},
47	"humidity": {
48	"type": "integer",
49	"description": "Humidity percentage"
50	}
51	},
52	"required": [
53	"temperature",
54	"condition"
55	]
56	},
57	"spaceId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
58	"updatedAt": "2024-06-01T12:30:00Z",
59	"metadata": {
60	"version": "1.2.0",
61	"author": "[email protected]",
62	"lastReviewed": "2024-05-20"
63	}
64	}

Get one custom tool definition, including its schemas, execution method, enabled state, and metadata. Use this to understand exactly what an agent may call.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

toolIdstringRequired

Response

Default Response

createdAtstring

descriptionstring or null<=2000 characters

enabledboolean

executionobject

idstringformat: "uuid"

inputSchemamap from strings to any

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

outputSchemamap from strings to any

spaceIdstringformat: "uuid"

updatedAtstring

metadatamap from strings to any or null