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: eJytVttu4zYQ/RVinhyAkXW1Lb1l03SRIhsvbKdAERhZRhpbbCVSISlnDUNAf6O/1y8pKNmxnXgTYFG/UJ4ZzRyeuWkDhi01JPcwk7LQMKeQoU4VrwyXAhKY5UgUPtWoDXmU2ZowkZHfpuNbolBXUmgkC6lKZjQpmUlzYnIkRsri37//0URXmPIFT5n15gAFWaFq/1xnkEAltQEKFVOsRIPKAtmAYCVC0h0UuEVRMZPDa2i3rEQiFy8RgYJFyhVmkBhVIwWd5lgySDZg1pV1qo3iYglNM++MUZtPMltbi1f3lrJ4gU+4qGpD9jgdMkUk/ZXXt4G1pWCvJV1Ue91UCoPCWPesqootEf0/tY2x2cNrKOB3VlYFWvFTjWoNCUyvbq4uZ4Stlj0jDSseWClrYc5oJ+LVXpDas+edUVIxrVEsUT20MvLrZPyFlOsHwx4LJJ8n47uv5NMfb8zGk1+uJqcUF9NLcnP95XpGAmia5jXHraArBG2x+677AzKnOzJ39pRw0ZVSV0E/xVcbVD8V9lixosa2hC5+/9zb3dk5IAqSwHGHvh/F8dAL4sEwDugr40OiIfEjJ/CHI28QB3EYDSI/onA5vrud9a6FGYQ978z69MJBZMv4iDlI3Ia+DyUYev7A90ejcDBy3Wj4AZaB47uRH7hhGIXDMI4HJ7D43mg0DOITaLyP0Ay9oRe4vucFfuyOovADNLET+e4giuPAjQM3cMMTaEI38tzgBBi/mTdNW06hG/6gYIQ0ZCFrkR0XhsHvpl8VjB+XxOsOP+ionbsH/XTotQ0fnarXK6WkIjJNa4UZec55oQ1JWVFwsTwcNz/X3iVqzZb4EufF8R5lQm4l0bUdpzbSlqoSTS6P5qbJIYGXMdTf2JnZAAWNarUbp7UqIIHcmCrp9wuZsiKX2iQjN3bfjNQbqyYZrrCQVYnCkM6TQy6lWPBlrZA8c5OTb+fn1uM3B+wk1ZjWipt1G49V/OEvtM9zq+NiIdv0cNPmQtXC8Hayv100uuIpZmRvUvAUhW5Z226Fi4qlOZ77jgXPMxSGLziqY01DwV6/c+w5YSeyrJVMHDib1ILMulQegdnsM/t/L8BtlR4UcUO7FG22+byHlWcN231MIWmxzinYrFntZvPINN6pommseLss7ucUVkxx26ptGjKu7XMGyYIVGt+5YW+ynehn5MRKPQl4K2RiDXQ3dgEotHnv2G3mDYUcWWaTc7/Zqi67qOcz62D/6pvusbOqe+MiTbEy79rOD1rj63g6AwqP26VeyqwtOvZsvw7YcwdTtiy0q6OVbaBgYll3Tdn5tL//ADjUDxQ=
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: eJytVttu4zYQ/RVinhyAkXW1Lb1l03SRIhsvbKdAERhZRhpbbCVSISlnDUNAf6O/1y8pKNmxnXgTYFG/UJ4ZzRyeuWkDhi01JPcwk7LQMKeQoU4VrwyXAhKY5UgUPtWoDXmU2ZowkZHfpuNbolBXUmgkC6lKZjQpmUlzYnIkRsri37//0URXmPIFT5n15gAFWaFq/1xnkEAltQEKFVOsRIPKAtmAYCVC0h0UuEVRMZPDa2i3rEQiFy8RgYJFyhVmkBhVIwWd5lgySDZg1pV1qo3iYglNM++MUZtPMltbi1f3lrJ4gU+4qGpD9jgdMkUk/ZXXt4G1pWCvJV1Ue91UCoPCWPesqootEf0/tY2x2cNrKOB3VlYFWvFTjWoNCUyvbq4uZ4Stlj0jDSseWClrYc5oJ+LVXpDas+edUVIxrVEsUT20MvLrZPyFlOsHwx4LJJ8n47uv5NMfb8zGk1+uJqcUF9NLcnP95XpGAmia5jXHraArBG2x+677AzKnOzJ39pRw0ZVSV0E/xVcbVD8V9lixosa2hC5+/9zb3dk5IAqSwHGHvh/F8dAL4sEwDugr40OiIfEjJ/CHI28QB3EYDSI/onA5vrud9a6FGYQ978z69MJBZMv4iDlI3Ia+DyUYev7A90ejcDBy3Wj4AZaB47uRH7hhGIXDMI4HJ7D43mg0DOITaLyP0Ay9oRe4vucFfuyOovADNLET+e4giuPAjQM3cMMTaEI38tzgBBi/mTdNW06hG/6gYIQ0ZCFrkR0XhsHvpl8VjB+XxOsOP+ionbsH/XTotQ0fnarXK6WkIjJNa4UZec55oQ1JWVFwsTwcNz/X3iVqzZb4EufF8R5lQm4l0bUdpzbSlqoSTS6P5qbJIYGXMdTf2JnZAAWNarUbp7UqIIHcmCrp9wuZsiKX2iQjN3bfjNQbqyYZrrCQVYnCkM6TQy6lWPBlrZA8c5OTb+fn1uM3B+wk1ZjWipt1G49V/OEvtM9zq+NiIdv0cNPmQtXC8Hayv100uuIpZmRvUvAUhW5Z226Fi4qlOZ77jgXPMxSGLziqY01DwV6/c+w5YSeyrJVMHDib1ILMulQegdnsM/t/L8BtlR4UcUO7FG22+byHlWcN231MIWmxzinYrFntZvPINN6pommseLss7ucUVkxx26ptGjKu7XMGyYIVGt+5YW+ynehn5MRKPQl4K2RiDXQ3dgEotHnv2G3mDYUcWWaTc7/Zqi67qOcz62D/6pvusbOqe+MiTbEy79rOD1rj63g6AwqP26VeyqwtOvZsvw7YcwdTtiy0q6OVbaBgYll3Tdn5tL//ADjUDxQ=
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