1---
2id: run-tool
3title: "Run Tool"
4description: "Execute a specific tool by name. The request body schema and response format are defined by each individual tool's specification. Use `GET /v1/tools` to discover available tools and their parameter schemas."
5sidebar_label: "Run Tool"
6hide_title: true
7hide_table_of_contents: true
8api: eJzdVl1P6zgQ/SvWvGyRQprPtskbl2URKy69grLSClVgkmnj3cQOtlOoqvz3lZ2UFugF6T5uX1KNJ2eOzxyPswFNlwrSO5gJUSqYO5CjyiSrNRMcUjh7wazRSChRNWZswTKihSjJ45pwWqFLZgUSiU8NKk0eRb4mKiuwooTynEhUteAKyULIimpCJZIcF4xjbgCQZgVhPGcrlje0tMC/qddC1FBwya1C8nB+NiPDlT80KeqBaEFypjKxQknoirKSPpZo31e2sC6QSVJTSSvUKHtOygUHRI3SIl/kkIJs+L15DRx4zTZybMDsDtLu4QAzWtRUF/BeoCtaIRELU5L0SEYOJjGHVMsGHeiqQ7oBva4NqNKS8SW07bxLRqW/iXxtMt6Cm6bshGe8bvRuV8olN4g7WYzKH/ZstpwJrpFrA0/ruuyVHf6jTI3Njl7rAL7Qqi7RhJ8alGtI4ebs8ux0RuhqOdBC0/KeVqLh+sjpQqzeBTLzHPhHDqmpUsiXKO9tjPxxPf1OqvW9to06v57e/iDf/v6QNr3+/ez60MLJzSm5vPh+MSMhtG37XmMb6LymDPfA834i5s1WzG2+Qxgnf95Mr3qT/pJetqh6Ks1jRcsGrYVO/jofbPfs7gkFaeh64yCIk2Tsh8lonITOu+R9oSENYjcMxhN/lIRJFI/iIHbgdHp7NRtccD2KBv6RwfSjUWxs/EY5SL3W+ZxKOPaDURBMJtFo4nnx+AsuIzfw4iD0oiiOxlGSjA5wCfzJZBwmB9j4X7EZ+2M/9ALfD4PEm8TRF2wSNw68UZwkoZeEXuhFB9hEXux74QEyQTtvW2unyIt+YhguNFmIhudvjaHxRQ/rkrK3lnh/wvdO1BbuXj3to9ry8SG/nnCCUgpJRJY1UmJOngtWIsloWTK+3J84v3bCK1SKLg21M1vnFXhHNCVXgqgmK7pKvVoV6kKY8VkLpe3o1AWk8DqJhhszNltwQKFcbSdqI0tIodC6TofDUmS0LITS6cRLvA9T9dIskxxXWIq6Qq5Jh+SSU8EXbNlIJM9MF+Th+NggPrhghqnCrJFMr209WrP7f9H8n5s1xhfCdohp2w7ZcM3scH/X9QKJqlmGOdmllCxDrqxq/cVwUtOswOPANeRZjlyzBUP5dqV1wGy/Aw5cz/WOG66sk82aka+ifA/1uuFk1vX0DavNrsX/vyu5PzN7R6p1Ordsemvdwco3ifYbxYHUqjV3wBjIrG42j1ThrSzb1oT7q+tu7sCKSmblNo7ImTL/c0gXtFT4icaD6/5+OSIHLviDhPsg5WtwtpcAgAPWgl1/23nrQIE0Nz652/RLp13V45kB2L364SCbydm9cZJlWOtPc+d7p/TH9GYGDjz2nxiVyK3/6bP5VqHPHU1hVbAXmY1toKR82XTzocM0v/8AOPpw2Q==
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";
22import Translate from "@docusaurus/Translate";
23
24<Heading
25 as={"h1"}
26 className={"openapi__heading"}
27 children={"Run Tool"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"post"}
33 path={"/v1/tools/{name}"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41Execute a specific tool by name. The request body schema and response format are defined by each individual tool's specification. Use `GET /v1/tools` to discover available tools and their parameter schemas.
42
43<Heading
44 id={"request"}
45 as={"h2"}
46 className={"openapi-tabs__heading"}
47>
48 <Translate id="theme.openapi.request.title">Request</Translate>
49</Heading>
50
51<ParamsDetails
52 {...require("./run-tool.ParamsDetails.json")}
53>
54
55</ParamsDetails>
56
57<RequestSchema
58 {...require("./run-tool.RequestSchema.json")}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 {...require("./run-tool.StatusCodes.json")}
65>
66
67</StatusCodes>
68
69
70
1---
2id: run-tool
3title: "Run Tool"
4description: "Execute a specific tool by name. The request body schema and response format are defined by each individual tool's specification. Use `GET /v1/tools` to discover available tools and their parameter schemas."
5sidebar_label: "Run Tool"
6hide_title: true
7hide_table_of_contents: true
8api: eJzdVl1P6zgQ/SvWvGyRQprPtskbl2URKy69grLSClVgkmnj3cQOtlOoqvz3lZ2UFugF6T5uX1KNJ2eOzxyPswFNlwrSO5gJUSqYO5CjyiSrNRMcUjh7wazRSChRNWZswTKihSjJ45pwWqFLZgUSiU8NKk0eRb4mKiuwooTynEhUteAKyULIimpCJZIcF4xjbgCQZgVhPGcrlje0tMC/qddC1FBwya1C8nB+NiPDlT80KeqBaEFypjKxQknoirKSPpZo31e2sC6QSVJTSSvUKHtOygUHRI3SIl/kkIJs+L15DRx4zTZybMDsDtLu4QAzWtRUF/BeoCtaIRELU5L0SEYOJjGHVMsGHeiqQ7oBva4NqNKS8SW07bxLRqW/iXxtMt6Cm6bshGe8bvRuV8olN4g7WYzKH/ZstpwJrpFrA0/ruuyVHf6jTI3Njl7rAL7Qqi7RhJ8alGtI4ebs8ux0RuhqOdBC0/KeVqLh+sjpQqzeBTLzHPhHDqmpUsiXKO9tjPxxPf1OqvW9to06v57e/iDf/v6QNr3+/ez60MLJzSm5vPh+MSMhtG37XmMb6LymDPfA834i5s1WzG2+Qxgnf95Mr3qT/pJetqh6Ks1jRcsGrYVO/jofbPfs7gkFaeh64yCIk2Tsh8lonITOu+R9oSENYjcMxhN/lIRJFI/iIHbgdHp7NRtccD2KBv6RwfSjUWxs/EY5SL3W+ZxKOPaDURBMJtFo4nnx+AsuIzfw4iD0oiiOxlGSjA5wCfzJZBwmB9j4X7EZ+2M/9ALfD4PEm8TRF2wSNw68UZwkoZeEXuhFB9hEXux74QEyQTtvW2unyIt+YhguNFmIhudvjaHxRQ/rkrK3lnh/wvdO1BbuXj3to9ry8SG/nnCCUgpJRJY1UmJOngtWIsloWTK+3J84v3bCK1SKLg21M1vnFXhHNCVXgqgmK7pKvVoV6kKY8VkLpe3o1AWk8DqJhhszNltwQKFcbSdqI0tIodC6TofDUmS0LITS6cRLvA9T9dIskxxXWIq6Qq5Jh+SSU8EXbNlIJM9MF+Th+NggPrhghqnCrJFMr209WrP7f9H8n5s1xhfCdohp2w7ZcM3scH/X9QKJqlmGOdmllCxDrqxq/cVwUtOswOPANeRZjlyzBUP5dqV1wGy/Aw5cz/WOG66sk82aka+ifA/1uuFk1vX0DavNrsX/vyu5PzN7R6p1Ordsemvdwco3ifYbxYHUqjV3wBjIrG42j1ThrSzb1oT7q+tu7sCKSmblNo7ImTL/c0gXtFT4icaD6/5+OSIHLviDhPsg5WtwtpcAgAPWgl1/23nrQIE0Nz652/RLp13V45kB2L364SCbydm9cZJlWOtPc+d7p/TH9GYGDjz2nxiVyK3/6bP5VqHPHU1hVbAXmY1toKR82XTzocM0v/8AOPpw2Q==
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";
22import Translate from "@docusaurus/Translate";
23
24<Heading
25 as={"h1"}
26 className={"openapi__heading"}
27 children={"Run Tool"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"post"}
33 path={"/v1/tools/{name}"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41Execute a specific tool by name. The request body schema and response format are defined by each individual tool's specification. Use `GET /v1/tools` to discover available tools and their parameter schemas.
42
43<Heading
44 id={"request"}
45 as={"h2"}
46 className={"openapi-tabs__heading"}
47>
48 <Translate id="theme.openapi.request.title">Request</Translate>
49</Heading>
50
51<ParamsDetails
52 {...require("./run-tool.ParamsDetails.json")}
53>
54
55</ParamsDetails>
56
57<RequestSchema
58 {...require("./run-tool.RequestSchema.json")}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 {...require("./run-tool.StatusCodes.json")}
65>
66
67</StatusCodes>
68
69
70