Skip to content

Commit d2ddfee

Browse files
xuwei-fit2cloudxuwei-fit2cloud
committed
Deployed 968c9a7 to v1 with MkDocs 1.6.1 and mike 1.1.2
1 parent 731307d commit d2ddfee

File tree

7 files changed

+85
-50
lines changed

7 files changed

+85
-50
lines changed

‎v1/faq/other/index.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2002,6 +2002,17 @@
20022002
</span>
20032003
</a>
20042004

2005+
</li>
2006+
2007+
<li class="md-nav__item">
2008+
<a href="#3-sqlbot-api" class="md-nav__link">
2009+
<span class="md-ellipsis">
2010+
2011+
3 如何使用 SQLBot 的 API？
2012+
2013+
</span>
2014+
</a>
2015+
20052016
</li>
20062017

20072018
</ul>
@@ -2314,6 +2325,17 @@
23142325
</span>
23152326
</a>
23162327

2328+
</li>
2329+
2330+
<li class="md-nav__item">
2331+
<a href="#3-sqlbot-api" class="md-nav__link">
2332+
<span class="md-ellipsis">
2333+
2334+
3 如何使用 SQLBot 的 API？
2335+
2336+
</span>
2337+
</a>
2338+
23172339
</li>
23182340

23192341
</ul>
@@ -2352,6 +2374,19 @@ <h2 id="2-sqlbot-api">2 SQLBot 支持 API 调用吗？<a class="headerlink" href
23522374
<p>如需了解 SQLBot 自身的 API 调用方式，可通过浏览器开发者工具查看其网络请求。目前系统尚未提供基于 API Key 的认证方式，但支持通过 Token 进行接口调用。用户可在登录过程中获取 Token，相应的获取接口可在登录时观察请求获得。</p>
23532375
<p>完整的 API 接口列表可在 SQLBot 访问地址后追加 /docs进行查看，例如：<a href="https://your-sqlbot-domain/docs">https://your-sqlbot-domain/docs</a>。</p>
23542376
</div>
2377+
<h2 id="3-sqlbot-api">3 如何使用 SQLBot 的 API？<a class="headerlink" href="#3-sqlbot-api" title="Permanent link">&para;</a></h2>
2378+
<div class="admonition abstract">
2379+
<p>SQLBot v1.5.0 版本开始正式支持了 API 的调用。可以在 API Key 页面获取对应的 Access Key 和 Secret Key。如下图所示：
2380+
<img alt="api_key" src="../../img/faq/api_key.png" /></p>
2381+
<p>生成 JWT Token。Token 的生成过程是标准化的，这里拿在线工具（<a href="https://www.bejson.com/jwt/">https://www.bejson.com/jwt/</a>）举例。其中 header 参考下图，Payload 中填入 SQLBot 的 Access Key，对称密钥填写 SQLBot 的 Secret Key。 点击编码按钮，生成对应的 Token。如下图所示：
2382+
<img alt="api_jwt" src="../../img/faq/api_jwt.png" /></p>
2383+
<p>生成 token 后，可以通过 API 调用工具来使用该 token 调用对应的接口。这里用在线工具（<a href="https://getman.cn/">https://getman.cn/</a>）举例。将生成的 token 复制下来，在请求的 header 里输入：
2384+
<div class="highlight"><pre><span></span><code># 下面的 xxx 为 token
2385+
x-sqlbot-ask-token: sk xxx
2386+
</code></pre></div>
2387+
在 URL 里输入需要调用的 API 接口地址，如下图所示：
2388+
<img alt="api_call" src="../../img/faq/api_call.png" /></p>
2389+
</div>
23552390

23562391

23572392

‎v1/img/faq/api_call.png‎

152 KB
Loading

‎v1/img/faq/api_jwt.png‎

106 KB
Loading

‎v1/img/faq/api_key.png‎

199 KB
Loading

‎v1/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎v1/sitemap.xml‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,198 +2,198 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://sqlbot.cn/docs/v1/</loc>
5-
<lastmod>2026-01-04</lastmod>
5+
<lastmod>2026-01-08</lastmod>
66
</url>
77
<url>
88
<loc>https://sqlbot.cn/docs/v1/best_practice/</loc>
9-
<lastmod>2026-01-04</lastmod>
9+
<lastmod>2026-01-08</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://sqlbot.cn/docs/v1/buy/</loc>
13-
<lastmod>2026-01-04</lastmod>
13+
<lastmod>2026-01-08</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://sqlbot.cn/docs/v1/changelog/</loc>
17-
<lastmod>2026-01-04</lastmod>
17+
<lastmod>2026-01-08</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://sqlbot.cn/docs/v1/contact/</loc>
21-
<lastmod>2026-01-04</lastmod>
21+
<lastmod>2026-01-08</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://sqlbot.cn/docs/v1/dataease_integration/</loc>
25-
<lastmod>2026-01-04</lastmod>
25+
<lastmod>2026-01-08</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://sqlbot.cn/docs/v1/embedding_integration/</loc>
29-
<lastmod>2026-01-04</lastmod>
29+
<lastmod>2026-01-08</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://sqlbot.cn/docs/v1/mcp_server/</loc>
33-
<lastmod>2026-01-04</lastmod>
33+
<lastmod>2026-01-08</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://sqlbot.cn/docs/v1/quick_start/</loc>
37-
<lastmod>2026-01-04</lastmod>
37+
<lastmod>2026-01-08</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://sqlbot.cn/docs/v1/system_arch/</loc>
41-
<lastmod>2026-01-04</lastmod>
41+
<lastmod>2026-01-08</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://sqlbot.cn/docs/v1/faq/assistant/</loc>
45-
<lastmod>2026-01-04</lastmod>
45+
<lastmod>2026-01-08</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://sqlbot.cn/docs/v1/faq/datasource/</loc>
49-
<lastmod>2026-01-04</lastmod>
49+
<lastmod>2026-01-08</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://sqlbot.cn/docs/v1/faq/installation/</loc>
53-
<lastmod>2026-01-04</lastmod>
53+
<lastmod>2026-01-08</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://sqlbot.cn/docs/v1/faq/mcp/</loc>
57-
<lastmod>2026-01-04</lastmod>
57+
<lastmod>2026-01-08</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://sqlbot.cn/docs/v1/faq/other/</loc>
61-
<lastmod>2026-01-04</lastmod>
61+
<lastmod>2026-01-08</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://sqlbot.cn/docs/v1/faq/smart_question_description/</loc>
65-
<lastmod>2026-01-04</lastmod>
65+
<lastmod>2026-01-08</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://sqlbot.cn/docs/v1/installation/1panel_installtion/</loc>
69-
<lastmod>2026-01-04</lastmod>
69+
<lastmod>2026-01-08</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://sqlbot.cn/docs/v1/installation/aliyun_installtion/</loc>
73-
<lastmod>2026-01-04</lastmod>
73+
<lastmod>2026-01-08</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://sqlbot.cn/docs/v1/installation/cli/</loc>
77-
<lastmod>2026-01-04</lastmod>
77+
<lastmod>2026-01-08</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://sqlbot.cn/docs/v1/installation/migration/</loc>
81-
<lastmod>2026-01-04</lastmod>
81+
<lastmod>2026-01-08</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://sqlbot.cn/docs/v1/installation/offline_installtion/</loc>
85-
<lastmod>2026-01-04</lastmod>
85+
<lastmod>2026-01-08</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://sqlbot.cn/docs/v1/installation/offline_upgrade/</loc>
89-
<lastmod>2026-01-04</lastmod>
89+
<lastmod>2026-01-08</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://sqlbot.cn/docs/v1/installation/online_installtion/</loc>
93-
<lastmod>2026-01-04</lastmod>
93+
<lastmod>2026-01-08</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://sqlbot.cn/docs/v1/installation/source_run/</loc>
97-
<lastmod>2026-01-04</lastmod>
97+
<lastmod>2026-01-08</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://sqlbot.cn/docs/v1/installation/windows_installation/</loc>
101-
<lastmod>2026-01-04</lastmod>
101+
<lastmod>2026-01-08</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://sqlbot.cn/docs/v1/model_integration/ollama/</loc>
105-
<lastmod>2026-01-04</lastmod>
105+
<lastmod>2026-01-08</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://sqlbot.cn/docs/v1/system/app/</loc>
109-
<lastmod>2026-01-04</lastmod>
109+
<lastmod>2026-01-08</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://sqlbot.cn/docs/v1/system/appearance_configuration/</loc>
113-
<lastmod>2026-01-04</lastmod>
113+
<lastmod>2026-01-08</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://sqlbot.cn/docs/v1/system/embedding/</loc>
117-
<lastmod>2026-01-04</lastmod>
117+
<lastmod>2026-01-08</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://sqlbot.cn/docs/v1/system/identification_setting/</loc>
121-
<lastmod>2026-01-04</lastmod>
121+
<lastmod>2026-01-08</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://sqlbot.cn/docs/v1/system/model/</loc>
125-
<lastmod>2026-01-04</lastmod>
125+
<lastmod>2026-01-08</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://sqlbot.cn/docs/v1/system/user/</loc>
129-
<lastmod>2026-01-04</lastmod>
129+
<lastmod>2026-01-08</lastmod>
130130
</url>
131131
<url>
132132
<loc>https://sqlbot.cn/docs/v1/system/workspace/</loc>
133-
<lastmod>2026-01-04</lastmod>
133+
<lastmod>2026-01-08</lastmod>
134134
</url>
135135
<url>
136136
<loc>https://sqlbot.cn/docs/v1/user_manual/dashboard_description/</loc>
137-
<lastmod>2026-01-04</lastmod>
137+
<lastmod>2026-01-08</lastmod>
138138
</url>
139139
<url>
140140
<loc>https://sqlbot.cn/docs/v1/user_manual/data_training/</loc>
141-
<lastmod>2026-01-04</lastmod>
141+
<lastmod>2026-01-08</lastmod>
142142
</url>
143143
<url>
144144
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_DM/</loc>
145-
<lastmod>2026-01-04</lastmod>
145+
<lastmod>2026-01-08</lastmod>
146146
</url>
147147
<url>
148148
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_clickhouse/</loc>
149-
<lastmod>2026-01-04</lastmod>
149+
<lastmod>2026-01-08</lastmod>
150150
</url>
151151
<url>
152152
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_description/</loc>
153-
<lastmod>2026-01-04</lastmod>
153+
<lastmod>2026-01-08</lastmod>
154154
</url>
155155
<url>
156156
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_excel/</loc>
157-
<lastmod>2026-01-04</lastmod>
157+
<lastmod>2026-01-08</lastmod>
158158
</url>
159159
<url>
160160
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_mysql/</loc>
161-
<lastmod>2026-01-04</lastmod>
161+
<lastmod>2026-01-08</lastmod>
162162
</url>
163163
<url>
164164
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_oracle/</loc>
165-
<lastmod>2026-01-04</lastmod>
165+
<lastmod>2026-01-08</lastmod>
166166
</url>
167167
<url>
168168
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_postgresql/</loc>
169-
<lastmod>2026-01-04</lastmod>
169+
<lastmod>2026-01-08</lastmod>
170170
</url>
171171
<url>
172172
<loc>https://sqlbot.cn/docs/v1/user_manual/datasource_sqlserver/</loc>
173-
<lastmod>2026-01-04</lastmod>
173+
<lastmod>2026-01-08</lastmod>
174174
</url>
175175
<url>
176176
<loc>https://sqlbot.cn/docs/v1/user_manual/member/</loc>
177-
<lastmod>2026-01-04</lastmod>
177+
<lastmod>2026-01-08</lastmod>
178178
</url>
179179
<url>
180180
<loc>https://sqlbot.cn/docs/v1/user_manual/permission/</loc>
181-
<lastmod>2026-01-04</lastmod>
181+
<lastmod>2026-01-08</lastmod>
182182
</url>
183183
<url>
184184
<loc>https://sqlbot.cn/docs/v1/user_manual/professional/</loc>
185-
<lastmod>2026-01-04</lastmod>
185+
<lastmod>2026-01-08</lastmod>
186186
</url>
187187
<url>
188188
<loc>https://sqlbot.cn/docs/v1/user_manual/prompt/</loc>
189-
<lastmod>2026-01-04</lastmod>
189+
<lastmod>2026-01-08</lastmod>
190190
</url>
191191
<url>
192192
<loc>https://sqlbot.cn/docs/v1/user_manual/setting/</loc>
193-
<lastmod>2026-01-04</lastmod>
193+
<lastmod>2026-01-08</lastmod>
194194
</url>
195195
<url>
196196
<loc>https://sqlbot.cn/docs/v1/user_manual/smart_question_description/</loc>
197-
<lastmod>2026-01-04</lastmod>
197+
<lastmod>2026-01-08</lastmod>
198198
</url>
199199
</urlset>

‎v1/sitemap.xml.gz‎

-1 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)