1---
2id: post-nsql
3title: "Text-to-SQL (NSQL)"
4description: "Generate and optionally execute a natural-language text-to-SQL (NSQL) query."
5sidebar_label: "Text-to-SQL (NSQL)"
6hide_title: true
7hide_table_of_contents: true
8api: eJztV21v2zYQ/iuH+9IWkxUna7pO+9SXrAiQvsUpisE2HEY6W2xpUiEpu4bh/z4cJVuS7RZZgWFf5k8Webx7ePfcC9foxcxhMsTBxyscR5iRS60svDQaE3xDmqzwBEJnYMKqUGoF9I3SkpdBC19aoXpK6FkpZgSevvmeN73Bxyt4/G7w8eoJ3JdkV/FIj/RNLh2QzgojtYdZrd2BABYPclA6qWeNZthprrZrnccBOZA+ZjPUUijdzlIGdyvwOYErKJVTSRnMTUYqqKt1ZCCnQeb2RZpS4W8hJ5GRZT3aeHDkwRu4FUWhZCoYwom7V7fxSH/OScOt85bE/JblvS0pCsosucJoR7xaCVAGwsGA7IJsb0Daw8WCtHfweDC4eBJjhKZg0NLoywwTLIzzE+3uFUZYCCvm5Mly6NaoxZwwwQovRig5dhVq3A8p+2Zq7Fx4MNMOtAiMJl581L7aF2f0I3ic0VSUyj+JursLncWukCkJGTO2eHH6SzixJ+fuFS8xOU5St3gExtZfhRJSP4oPxWEplQKj1Qos+dLqALYJ60FMQyTZb5buS2kpwyT4H12a01xgska/KthRzlupZ7jZjCthcv6lyVYs0XXWdbUJdyZbcdBnTT7Aux0UjDA12pP2rGHfebx2gMDcfaHUd7AOsVI2jrCwHHovyQVIwgtH3jXHhyisFWxXl0rxCelp7o7ccD/678ScHMd4q5Rv5cS8UARTa+awZAqnRjtvy9RzJlYJEi74zf8BnlNYcsqGYyyRczJzBmWGqhyxxABSD8tcpjl4cafIBWdJcpAKDV7YGfkYLqdg5tJ7yiIQSjW4hCUoHWUxXyJgOLzeMW5zLmyZXUH3hhUx6QN76hhKo2N4XbE6gRHqezVCtlVF4YG2jpYob+CO2GMLsqGeaG/YNGuvfD3ha05Is1+ylq07YxQJfWDsc04+J7uNFJ/mGEidqjILFsJ96yD9+KqcEwFJqEIPMH45retYdcLt1TPtPImMXb4UMjCGzaeGkQYNm02EXnpFTUKxffoWLsMAapfjGy6tOYE3BZxDWjpv5mRdSHDjhQInFDnc8YGDhs1NpkI5+o6Lq0rQpNIQg64gheMNY+yWjbBQ3TEk1lm/f1gfmmq0ax6uTFNybloq9TOFYZvY24TetD01XOPWKRPJPeH07Nen5xhh8M6k8k5yet7v9/ubaF/42W/Pf+8fCJ+x9Ga8iXCvAB+F19SVHSgcaWj9BhdXF69uoGU6gsGnt49bVp90T/x5/f4tNNHobr65fv/pA7z8q62wK/H++vXFNUvsW4HXF4NXXdmry7eXN3DeXcS9u3+vp3Uc0iWwNctJakqO81m730wlqazTo9shqfg4qV072NYZrunM2h2hM5n6EML+9r+bGJtR4GqQ4WDXBtrR7Rq41P7Z05/Uz/wIqfJvcjDCQDt8CIXgxQBa3yN9wKLjzNmxpXW4JkpNjqpe8WhCPI/1mjr5oGxg4wmsRw0nRpjAWQSj+jx/ruM43vBSgIoJDOM4HgcZbkPcj2onxHE8wg3PzhiK1NNjZehSL4SSGdSzDLTGw39egY5d6m1opJwMob1PTamzCs/5cTyerOZ6HaZbIGuN7UJpZr8Hg3hn6lpbWJOVKWXVxBLmsKohbAKkOfncbCfmMCz7HBM8WZye1ONzBavKy9Iy5XLvi+TkRJlUqNw4nzzvB55273XF25DRgpQp5jyyV5pieGX0VM5KS7CUPofbXo813sYYWE1paaVfBXuikJOvxP/HvMdhuG5G0IumpjS9Cj/pr9osNdysCkogtIgoTH5NJ9xNKdteulv4QTvcUrvud1JPTYhB3axtqb2c09HRJxTIDBoRJVPSLiDfPkcKkebUO4vZkTIj7fnFZbs7mwg5FJXis7gf93uldmFg5D0O4Vzoltabg/flPr51w7P/H7D/6QO2TuZWrm+iKuHWdVYOcXHKLYnzchwhpx4vrtd3wtEnqzYbXq45PRxHuBBWVs1ryD2pfuRyYoWkwldV6HucKsjiqgxj1X7l49ZUndi9mr8vO24VlQ/vBzcY4V39XmTvc6qIJT/mxBITDC93Ph3mxrC2xi0JMMFKJ//+BnL7ADA=
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={"Text-to-SQL (NSQL)"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"post"}
33 path={"/v1/nsql"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41Generate and optionally execute a natural-language text-to-SQL (NSQL) query.
42
43This endpoint generates a SQL query using a natural language query (NSQL) and optionally executes it.
44The SQL query is generated by the specified model and executed if the `Accept` header is not set to `application/sql`.
45When `stream` is true, the response is streamed as Server-Sent Events (SSE).
46
47<Heading
48 id={"request"}
49 as={"h2"}
50 className={"openapi-tabs__heading"}
51>
52 <Translate id="theme.openapi.request.title">Request</Translate>
53</Heading>
54
55<ParamsDetails
56 {...require("./post-nsql.ParamsDetails.json")}
57>
58
59</ParamsDetails>
60
61<RequestSchema
62 {...require("./post-nsql.RequestSchema.json")}
63>
64
65</RequestSchema>
66
67<StatusCodes
68 {...require("./post-nsql.StatusCodes.json")}
69>
70
71</StatusCodes>
72
73
74
1---
2id: post-nsql
3title: "Text-to-SQL (NSQL)"
4description: "Generate and optionally execute a natural-language text-to-SQL (NSQL) query."
5sidebar_label: "Text-to-SQL (NSQL)"
6hide_title: true
7hide_table_of_contents: true
8api: eJztV21v2zYQ/iuH+9IWkxUna7pO+9SXrAiQvsUpisE2HEY6W2xpUiEpu4bh/z4cJVuS7RZZgWFf5k8Webx7ePfcC9foxcxhMsTBxyscR5iRS60svDQaE3xDmqzwBEJnYMKqUGoF9I3SkpdBC19aoXpK6FkpZgSevvmeN73Bxyt4/G7w8eoJ3JdkV/FIj/RNLh2QzgojtYdZrd2BABYPclA6qWeNZthprrZrnccBOZA+ZjPUUijdzlIGdyvwOYErKJVTSRnMTUYqqKt1ZCCnQeb2RZpS4W8hJ5GRZT3aeHDkwRu4FUWhZCoYwom7V7fxSH/OScOt85bE/JblvS0pCsosucJoR7xaCVAGwsGA7IJsb0Daw8WCtHfweDC4eBJjhKZg0NLoywwTLIzzE+3uFUZYCCvm5Mly6NaoxZwwwQovRig5dhVq3A8p+2Zq7Fx4MNMOtAiMJl581L7aF2f0I3ic0VSUyj+JursLncWukCkJGTO2eHH6SzixJ+fuFS8xOU5St3gExtZfhRJSP4oPxWEplQKj1Qos+dLqALYJ60FMQyTZb5buS2kpwyT4H12a01xgska/KthRzlupZ7jZjCthcv6lyVYs0XXWdbUJdyZbcdBnTT7Aux0UjDA12pP2rGHfebx2gMDcfaHUd7AOsVI2jrCwHHovyQVIwgtH3jXHhyisFWxXl0rxCelp7o7ccD/678ScHMd4q5Rv5cS8UARTa+awZAqnRjtvy9RzJlYJEi74zf8BnlNYcsqGYyyRczJzBmWGqhyxxABSD8tcpjl4cafIBWdJcpAKDV7YGfkYLqdg5tJ7yiIQSjW4hCUoHWUxXyJgOLzeMW5zLmyZXUH3hhUx6QN76hhKo2N4XbE6gRHqezVCtlVF4YG2jpYob+CO2GMLsqGeaG/YNGuvfD3ha05Is1+ylq07YxQJfWDsc04+J7uNFJ/mGEidqjILFsJ96yD9+KqcEwFJqEIPMH45retYdcLt1TPtPImMXb4UMjCGzaeGkQYNm02EXnpFTUKxffoWLsMAapfjGy6tOYE3BZxDWjpv5mRdSHDjhQInFDnc8YGDhs1NpkI5+o6Lq0rQpNIQg64gheMNY+yWjbBQ3TEk1lm/f1gfmmq0ax6uTFNybloq9TOFYZvY24TetD01XOPWKRPJPeH07Nen5xhh8M6k8k5yet7v9/ubaF/42W/Pf+8fCJ+x9Ga8iXCvAB+F19SVHSgcaWj9BhdXF69uoGU6gsGnt49bVp90T/x5/f4tNNHobr65fv/pA7z8q62wK/H++vXFNUvsW4HXF4NXXdmry7eXN3DeXcS9u3+vp3Uc0iWwNctJakqO81m730wlqazTo9shqfg4qV072NYZrunM2h2hM5n6EML+9r+bGJtR4GqQ4WDXBtrR7Rq41P7Z05/Uz/wIqfJvcjDCQDt8CIXgxQBa3yN9wKLjzNmxpXW4JkpNjqpe8WhCPI/1mjr5oGxg4wmsRw0nRpjAWQSj+jx/ruM43vBSgIoJDOM4HgcZbkPcj2onxHE8wg3PzhiK1NNjZehSL4SSGdSzDLTGw39egY5d6m1opJwMob1PTamzCs/5cTyerOZ6HaZbIGuN7UJpZr8Hg3hn6lpbWJOVKWXVxBLmsKohbAKkOfncbCfmMCz7HBM8WZye1ONzBavKy9Iy5XLvi+TkRJlUqNw4nzzvB55273XF25DRgpQp5jyyV5pieGX0VM5KS7CUPofbXo813sYYWE1paaVfBXuikJOvxP/HvMdhuG5G0IumpjS9Cj/pr9osNdysCkogtIgoTH5NJ9xNKdteulv4QTvcUrvud1JPTYhB3axtqb2c09HRJxTIDBoRJVPSLiDfPkcKkebUO4vZkTIj7fnFZbs7mwg5FJXis7gf93uldmFg5D0O4Vzoltabg/flPr51w7P/H7D/6QO2TuZWrm+iKuHWdVYOcXHKLYnzchwhpx4vrtd3wtEnqzYbXq45PRxHuBBWVs1ryD2pfuRyYoWkwldV6HucKsjiqgxj1X7l49ZUndi9mr8vO24VlQ/vBzcY4V39XmTvc6qIJT/mxBITDC93Ph3mxrC2xi0JMMFKJ//+BnL7ADA=
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={"Text-to-SQL (NSQL)"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"post"}
33 path={"/v1/nsql"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41Generate and optionally execute a natural-language text-to-SQL (NSQL) query.
42
43This endpoint generates a SQL query using a natural language query (NSQL) and optionally executes it.
44The SQL query is generated by the specified model and executed if the `Accept` header is not set to `application/sql`.
45When `stream` is true, the response is streamed as Server-Sent Events (SSE).
46
47<Heading
48 id={"request"}
49 as={"h2"}
50 className={"openapi-tabs__heading"}
51>
52 <Translate id="theme.openapi.request.title">Request</Translate>
53</Heading>
54
55<ParamsDetails
56 {...require("./post-nsql.ParamsDetails.json")}
57>
58
59</ParamsDetails>
60
61<RequestSchema
62 {...require("./post-nsql.RequestSchema.json")}
63>
64
65</RequestSchema>
66
67<StatusCodes
68 {...require("./post-nsql.StatusCodes.json")}
69>
70
71</StatusCodes>
72
73
74