1---
2id: post
3title: "Run Tool"
4description: "The request body and JSON response formats match the tool’s specification."
5sidebar_label: "Run Tool"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVm1v4jgQ/ivWfKKSG/IKJN+6vd6qp25ZAT3pVKGumwzEd4md2g5dhCLd37i/d7/k5AQKtGwrrY4vgZnJzONnHs+wAcOWGpJ7mElZaJhTyFCnileGSwEJzHIkCp9q1IY8ymxNmMjIb9PxLVGoKyk0koVUJTOalMykOTE5EiNl8e/f/2iiK0z5gqfMZnOAgqxQtT+uM0igktoAhYopVqJBZYFsQLASIekeFLhFUTGTw2tot6xEIhcvFYGCRcoVZpAYVSMFneZYMkg2YNaVTaqN4mIJTTPvglGbTzJb24hX55ayeIFPuKhqQ/Y4HTJFJP2V17eFtaVg7yVdVXvcVAqDwtj0rKqKLRH9P7WtsdnDayjgd1ZWBVrzU41qDQlMr26uLmeErZY9Iw0rHlgpa2HOaGfi1d6Q2mfPO6OkYlqjWKJ6aG3k18n4CynXD4Y9Fkg+T8Z3X8mnP96EjSe/XE1OOS6ml+Tm+sv1jATQNM1rjltDJwRtsfuu+wMypzsyd/GUcNFJqVPQT/HVFtVPhX2sWFFjK6GL3z/3dmd2DoiCJHDcoe9HcTz0gngwjAP6KviQaEj8yAn84cgbxEEcRoPIjyhcju9uZ71rYQZhzzuzOb1wEFkZHzEHidvQ96EEQ88f+P5oFA5GrhsNP8AycHw38gM3DKNwGMbx4AQW3xuNhkF8Ao33EZqhN/QC1/e8wI/dURR+gCZ2It8dRHEcuHHgBm54Ak3oRp4bnADjN/OmaeUUuuEPBCOkIQtZi+xYGAa/m35VMH4sidc3/OBG7dI96KfDrG356JRer5SSisg0rRVm5DnnhTYkZUXBxfJw3Pzc9S5Ra7bElzovifcoE3Iria7tOLWVtlSVaHJ5NDdNDgm8jKH+xs7MBihoVKvdOK1VAQnkxlRJv1/IlBW51CYZubH7ZqTeWDfJcIWFrEoUhnSZHHIpxYIva4XkmZucfDs/txm/OWAnqca0Vtys23qs4g9/of0+tz4uFrJtDzdtL1QtDG8n+9tFoyueYkb2IQVPUeiWte1WuKhYmuO571jwPENh+IKjOvY0FOzxu8SeM3Dc81roVsbWZ+krmTjIOqkFmXU9PUK12bf4/96EW7keqLmhXa8228bew8qzge1ippC0WOcUbPusd7N5ZBrvVNE01rzdGvdzCiumeHtY24+Ma/s9g2TBCo3vnLA32Y72M3Jit54EvDUysQa6m78AFFoBdOw284ZCjiyzXbrfbF2XXdXzmU2wf/XNNbJDq3vjIk2xMu/Gzg/uyNfxdAYUHrfbvZRZqz72bP8msOcOpmxZaHdIa9tAwcSy7m5nl9N+/gPqqBKh
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Run Tool"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/tools/{name}"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40The request body and JSON response formats match the tool’s specification.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"name","in":"path","description":"Name of the tool","required":true,"schema":{"type":"string"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Tool specific input parameters. See /v1/tools for parameter schema.","content":{"application/json":{"schema":{},"example":{"query":"SELECT avg(total_amount), avg(tip_amount), count(1), passenger_count FROM my_table GROUP BY passenger_count ORDER BY passenger_count ASC LIMIT 3"}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Tool Specific response, in JSON format","content":{"application/json":{"schema":{},"examples":{"sql":{"value":[{"AVG(my_table.tip_amount)":3.072259971396793,"AVG(my_table.total_amount)":25.327816939456525,"COUNT(Int64(1))":31465,"passenger_count":0},{"AVG(my_table.tip_amount)":3.3712622884680057,"AVG(my_table.total_amount)":26.205230445474996,"COUNT(Int64(1))":2188739,"passenger_count":1},{"AVG(my_table.tip_amount)":3.7171302113290854,"AVG(my_table.total_amount)":29.520659930930304,"COUNT(Int64(1))":405103,"passenger_count":2}]}}}}},"404":{"description":"Tool not found","content":{"text/plain":{"schema":{"type":"string"},"example":"Tool no_sql not found"}}},"500":{"description":"Error occured whilst calling the tool","content":{"application/json":{"schema":{},"example":{"message":"Error calling tool no_sql: No such tool"}}}}}}
67>
68
69</StatusCodes>
70
71
72
1---
2id: post
3title: "Run Tool"
4description: "The request body and JSON response formats match the tool’s specification."
5sidebar_label: "Run Tool"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVm1v4jgQ/ivWfKKSG/IKJN+6vd6qp25ZAT3pVKGumwzEd4md2g5dhCLd37i/d7/k5AQKtGwrrY4vgZnJzONnHs+wAcOWGpJ7mElZaJhTyFCnileGSwEJzHIkCp9q1IY8ymxNmMjIb9PxLVGoKyk0koVUJTOalMykOTE5EiNl8e/f/2iiK0z5gqfMZnOAgqxQtT+uM0igktoAhYopVqJBZYFsQLASIekeFLhFUTGTw2tot6xEIhcvFYGCRcoVZpAYVSMFneZYMkg2YNaVTaqN4mIJTTPvglGbTzJb24hX55ayeIFPuKhqQ/Y4HTJFJP2V17eFtaVg7yVdVXvcVAqDwtj0rKqKLRH9P7WtsdnDayjgd1ZWBVrzU41qDQlMr26uLmeErZY9Iw0rHlgpa2HOaGfi1d6Q2mfPO6OkYlqjWKJ6aG3k18n4CynXD4Y9Fkg+T8Z3X8mnP96EjSe/XE1OOS6ml+Tm+sv1jATQNM1rjltDJwRtsfuu+wMypzsyd/GUcNFJqVPQT/HVFtVPhX2sWFFjK6GL3z/3dmd2DoiCJHDcoe9HcTz0gngwjAP6KviQaEj8yAn84cgbxEEcRoPIjyhcju9uZ71rYQZhzzuzOb1wEFkZHzEHidvQ96EEQ88f+P5oFA5GrhsNP8AycHw38gM3DKNwGMbx4AQW3xuNhkF8Ao33EZqhN/QC1/e8wI/dURR+gCZ2It8dRHEcuHHgBm54Ak3oRp4bnADjN/OmaeUUuuEPBCOkIQtZi+xYGAa/m35VMH4sidc3/OBG7dI96KfDrG356JRer5SSisg0rRVm5DnnhTYkZUXBxfJw3Pzc9S5Ra7bElzovifcoE3Iria7tOLWVtlSVaHJ5NDdNDgm8jKH+xs7MBihoVKvdOK1VAQnkxlRJv1/IlBW51CYZubH7ZqTeWDfJcIWFrEoUhnSZHHIpxYIva4XkmZucfDs/txm/OWAnqca0Vtys23qs4g9/of0+tz4uFrJtDzdtL1QtDG8n+9tFoyueYkb2IQVPUeiWte1WuKhYmuO571jwPENh+IKjOvY0FOzxu8SeM3Dc81roVsbWZ+krmTjIOqkFmXU9PUK12bf4/96EW7keqLmhXa8228bew8qzge1ippC0WOcUbPusd7N5ZBrvVNE01rzdGvdzCiumeHtY24+Ma/s9g2TBCo3vnLA32Y72M3Jit54EvDUysQa6m78AFFoBdOw284ZCjiyzXbrfbF2XXdXzmU2wf/XNNbJDq3vjIk2xMu/Gzg/uyNfxdAYUHrfbvZRZqz72bP8msOcOpmxZaHdIa9tAwcSy7m5nl9N+/gPqqBKh
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Run Tool"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/tools/{name}"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40The request body and JSON response formats match the tool’s specification.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"name","in":"path","description":"Name of the tool","required":true,"schema":{"type":"string"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Tool specific input parameters. See /v1/tools for parameter schema.","content":{"application/json":{"schema":{},"example":{"query":"SELECT avg(total_amount), avg(tip_amount), count(1), passenger_count FROM my_table GROUP BY passenger_count ORDER BY passenger_count ASC LIMIT 3"}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Tool Specific response, in JSON format","content":{"application/json":{"schema":{},"examples":{"sql":{"value":[{"AVG(my_table.tip_amount)":3.072259971396793,"AVG(my_table.total_amount)":25.327816939456525,"COUNT(Int64(1))":31465,"passenger_count":0},{"AVG(my_table.tip_amount)":3.3712622884680057,"AVG(my_table.total_amount)":26.205230445474996,"COUNT(Int64(1))":2188739,"passenger_count":1},{"AVG(my_table.tip_amount)":3.7171302113290854,"AVG(my_table.total_amount)":29.520659930930304,"COUNT(Int64(1))":405103,"passenger_count":2}]}}}}},"404":{"description":"Tool not found","content":{"text/plain":{"schema":{"type":"string"},"example":"Tool no_sql not found"}}},"500":{"description":"Error occured whilst calling the tool","content":{"application/json":{"schema":{},"example":{"message":"Error calling tool no_sql: No such tool"}}}}}}
67>
68
69</StatusCodes>
70
71
72