-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-docs.html
More file actions
710 lines (704 loc) · 205 KB
/
api-docs.html
File metadata and controls
710 lines (704 loc) · 205 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>Scalytics Copilot API</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
padding: 0;
margin: 0;
}
</style>
<script src="https://cdn.redocly.com/redoc/v2.5.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.18">.iRoSfe{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.iRoSfe{width:100%;padding:40px 40px;}}/*!sc*/
.ciCSbi{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.ciCSbi{width:100%;padding:0px 40px;}}/*!sc*/
data-styled.g4[id="sc-gwsNht"]{content:"iRoSfe,ciCSbi,"}/*!sc*/
.kDuBQd{padding:40px 0;}/*!sc*/
.kDuBQd:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.kDuBQd>.kDuBQd:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.kDuBQd{padding:0;}}/*!sc*/
.dRVblm{padding:40px 0;position:relative;}/*!sc*/
.dRVblm:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.dRVblm>.dRVblm:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.dRVblm{padding:0;}}/*!sc*/
.dRVblm:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
data-styled.g5[id="sc-dYOLZc"]{content:"kDuBQd,dRVblm,"}/*!sc*/
.kCcXaS{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.kCcXaS{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g6[id="sc-jMpmlX"]{content:"kCcXaS,"}/*!sc*/
.jpPJrn{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-hoLldG"]{content:"jpPJrn,"}/*!sc*/
.tMeMv{display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width: 75rem){.tMeMv{flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-jZhnRx"]{content:"tMeMv,"}/*!sc*/
.dKykVD{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
data-styled.g9[id="sc-hBDmJg"]{content:"dKykVD,"}/*!sc*/
.jkwlQD{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
data-styled.g10[id="sc-kThouk"]{content:"jkwlQD,"}/*!sc*/
.fdkIVZ{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-llIIlC"]{content:"fdkIVZ,"}/*!sc*/
.eUkINt{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-elFkmj"]{content:"eUkINt,"}/*!sc*/
.jOWzfS{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.jOWzfS:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover>.jOWzfS::before,h2:hover>.jOWzfS::before,.jOWzfS:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-kieALA"]{content:"jOWzfS,"}/*!sc*/
.bnalXq{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.gsIrbT{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.dpIKEE{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.dpIKEE polygon{fill:#1d8127;}/*!sc*/
.NOyYc{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
.NOyYc polygon{fill:white;}/*!sc*/
.eVNtOe{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
data-styled.g15[id="sc-dibcMh"]{content:"bnalXq,gsIrbT,dpIKEE,NOyYc,eVNtOe,"}/*!sc*/
.cDFxGr{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width: 50rem){.cDFxGr{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type>.cDFxGr,tr.last>.cDFxGr{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type>.cDFxGr{background-image:linear-gradient(
to bottom,
transparent 0%,
transparent 22px,
#7c7cbb 22px,
#7c7cbb 100%
);}/*!sc*/
tr.last>.cDFxGr{background-image:linear-gradient(
to bottom,
#7c7cbb 0%,
#7c7cbb 22px,
transparent 22px,
transparent 100%
);}/*!sc*/
tr.last+tr>.cDFxGr{border-left-color:transparent;}/*!sc*/
tr.last:first-child>.cDFxGr{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-kHNKno"]{content:"cDFxGr,"}/*!sc*/
.kNAbAx{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.kNAbAx.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-frmfij"]{content:"kNAbAx,"}/*!sc*/
.dzPbxx{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .dzPbxx{border-bottom:none;}/*!sc*/
@media screen and (max-width: 50rem){.dzPbxx{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.dzPbxx{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-groBii"]{content:"dzPbxx,"}/*!sc*/
.lhCIDE{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.lhCIDE::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
.lhCIDE::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
data-styled.g22[id="sc-hLyRwt"]{content:"lhCIDE,"}/*!sc*/
.cGiuNU{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
.cGiuNU >tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width: 50rem){.cGiuNU{display:block;}.cGiuNU >tr,.cGiuNU >tbody>tr{display:block;}}/*!sc*/
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.cGiuNU td{float:left;width:100%;}}/*!sc*/
.cGiuNU .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.cGiuNU .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-eGjrzz"]{content:"cGiuNU,"}/*!sc*/
.dFpYBv >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.dFpYBv >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.dFpYBv >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.dFpYBv >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.dFpYBv >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
.dFpYBv >ul >li.tab-success{color:#1d8127;}/*!sc*/
.dFpYBv >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
.dFpYBv >ul >li.tab-info{color:#87ceeb;}/*!sc*/
.dFpYBv >ul >li.tab-error{color:#d41f1c;}/*!sc*/
.dFpYBv >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
.dFpYBv >.react-tabs__tab-panel>div,.dFpYBv >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
.dFpYBv >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
data-styled.g30[id="sc-cTIdZS"]{content:"dFpYBv,"}/*!sc*/
.kOqeZB code[class*='language-'],.kOqeZB pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.kOqeZB code[class*='language-'],.kOqeZB pre[class*='language-']{text-shadow:none;}}/*!sc*/
.kOqeZB pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.kOqeZB .token.comment,.kOqeZB .token.prolog,.kOqeZB .token.doctype,.kOqeZB .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
.kOqeZB .token.punctuation{opacity:0.7;}/*!sc*/
.kOqeZB .namespace{opacity:0.7;}/*!sc*/
.kOqeZB .token.property,.kOqeZB .token.tag,.kOqeZB .token.number,.kOqeZB .token.constant,.kOqeZB .token.symbol{color:#4a8bb3;}/*!sc*/
.kOqeZB .token.boolean{color:#e64441;}/*!sc*/
.kOqeZB .token.selector,.kOqeZB .token.attr-name,.kOqeZB .token.string,.kOqeZB .token.char,.kOqeZB .token.builtin,.kOqeZB .token.inserted{color:#a0fbaa;}/*!sc*/
.kOqeZB .token.selector+a,.kOqeZB .token.attr-name+a,.kOqeZB .token.string+a,.kOqeZB .token.char+a,.kOqeZB .token.builtin+a,.kOqeZB .token.inserted+a,.kOqeZB .token.selector+a:visited,.kOqeZB .token.attr-name+a:visited,.kOqeZB .token.string+a:visited,.kOqeZB .token.char+a:visited,.kOqeZB .token.builtin+a:visited,.kOqeZB .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
.kOqeZB .token.property.string{color:white;}/*!sc*/
.kOqeZB .token.operator,.kOqeZB .token.entity,.kOqeZB .token.url,.kOqeZB .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
.kOqeZB .token.atrule,.kOqeZB .token.attr-value,.kOqeZB .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
.kOqeZB .token.regex,.kOqeZB .token.important{color:#e90;}/*!sc*/
.kOqeZB .token.important,.kOqeZB .token.bold{font-weight:bold;}/*!sc*/
.kOqeZB .token.italic{font-style:italic;}/*!sc*/
.kOqeZB .token.entity{cursor:help;}/*!sc*/
.kOqeZB .token.deleted{color:red;}/*!sc*/
data-styled.g32[id="sc-faJlkc"]{content:"kOqeZB,"}/*!sc*/
.itwxyW{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.itwxyW:focus-within{opacity:1;}/*!sc*/
.itwxyW >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.itwxyW >button :hover,.itwxyW >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
data-styled.g33[id="sc-VILhF"]{content:"itwxyW,"}/*!sc*/
.dkdAtf{position:relative;}/*!sc*/
data-styled.g37[id="sc-epGxBs"]{content:"dkdAtf,"}/*!sc*/
.egUEEs{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.egUEEs polyline{color:white;}/*!sc*/
data-styled.g38[id="sc-kFXyV"]{content:"egUEEs,"}/*!sc*/
.bJuEgN{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
.bJuEgN label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
.bJuEgN .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
.bJuEgN:hover,.bJuEgN:focus-within{border:1px solid #32329f;color:#32329f;box-shadow:0px 0px 0px 1px #32329f;}/*!sc*/
data-styled.g39[id="sc-cIozSW"]{content:"bJuEgN,"}/*!sc*/
.iFdOsg{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g41[id="sc-edaYAx"]{content:"iFdOsg,"}/*!sc*/
.kEOvim{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.kEOvim p:last-child{margin-bottom:0;}/*!sc*/
.kEOvim h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.kEOvim h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.kEOvim code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.kEOvim pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.kEOvim pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.kEOvim pre code:before,.kEOvim pre code:after{content:none;}/*!sc*/
.kEOvim blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.kEOvim img{max-width:100%;box-sizing:content-box;}/*!sc*/
.kEOvim ul,.kEOvim ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.kEOvim ul ul,.kEOvim ol ul,.kEOvim ul ol,.kEOvim ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.kEOvim table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.kEOvim table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.kEOvim table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.kEOvim table th,.kEOvim table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.kEOvim table th{text-align:left;font-weight:bold;}/*!sc*/
.kEOvim .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.kEOvim .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.kEOvim h1:hover>.share-link::before,.kEOvim h2:hover>.share-link::before,.kEOvim .share-link:hover::before{visibility:visible;}/*!sc*/
.kEOvim a{text-decoration:auto;color:#32329f;}/*!sc*/
.kEOvim a:visited{color:#32329f;}/*!sc*/
.kEOvim a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
.kkltVg{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.kkltVg p:last-child{margin-bottom:0;}/*!sc*/
.kkltVg p:first-child{margin-top:0;}/*!sc*/
.kkltVg p:last-child{margin-bottom:0;}/*!sc*/
.kkltVg p{display:inline-block;}/*!sc*/
.kkltVg h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.kkltVg h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.kkltVg code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.kkltVg pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.kkltVg pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.kkltVg pre code:before,.kkltVg pre code:after{content:none;}/*!sc*/
.kkltVg blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.kkltVg img{max-width:100%;box-sizing:content-box;}/*!sc*/
.kkltVg ul,.kkltVg ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.kkltVg ul ul,.kkltVg ol ul,.kkltVg ul ol,.kkltVg ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.kkltVg table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.kkltVg table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.kkltVg table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.kkltVg table th,.kkltVg table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.kkltVg table th{text-align:left;font-weight:bold;}/*!sc*/
.kkltVg .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.kkltVg .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.kkltVg h1:hover>.share-link::before,.kkltVg h2:hover>.share-link::before,.kkltVg .share-link:hover::before{visibility:visible;}/*!sc*/
.kkltVg a{text-decoration:auto;color:#32329f;}/*!sc*/
.kkltVg a:visited{color:#32329f;}/*!sc*/
.kkltVg a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
.csbUjU{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.csbUjU p:last-child{margin-bottom:0;}/*!sc*/
.csbUjU p:first-child{margin-top:0;}/*!sc*/
.csbUjU p:last-child{margin-bottom:0;}/*!sc*/
.csbUjU h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.csbUjU h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.csbUjU code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.csbUjU pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.csbUjU pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.csbUjU pre code:before,.csbUjU pre code:after{content:none;}/*!sc*/
.csbUjU blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.csbUjU img{max-width:100%;box-sizing:content-box;}/*!sc*/
.csbUjU ul,.csbUjU ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.csbUjU ul ul,.csbUjU ol ul,.csbUjU ul ol,.csbUjU ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.csbUjU table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.csbUjU table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.csbUjU table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.csbUjU table th,.csbUjU table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.csbUjU table th{text-align:left;font-weight:bold;}/*!sc*/
.csbUjU .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.csbUjU .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.csbUjU h1:hover>.share-link::before,.csbUjU h2:hover>.share-link::before,.csbUjU .share-link:hover::before{visibility:visible;}/*!sc*/
.csbUjU a{text-decoration:auto;color:#32329f;}/*!sc*/
.csbUjU a:visited{color:#32329f;}/*!sc*/
.csbUjU a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g42[id="sc-fdduAw"]{content:"kEOvim,kkltVg,csbUjU,"}/*!sc*/
.fbuMAW{display:inline;}/*!sc*/
data-styled.g43[id="sc-eINXvP"]{content:"fbuMAW,"}/*!sc*/
.indwFD{position:relative;}/*!sc*/
data-styled.g44[id="sc-fIQtvO"]{content:"indwFD,"}/*!sc*/
.iAOzgg:hover>.sc-VILhF{opacity:1;}/*!sc*/
data-styled.g49[id="sc-dRHutB"]{content:"iAOzgg,"}/*!sc*/
.eudsMA{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.eudsMA .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
.eudsMA .callback-function{color:gray;}/*!sc*/
.eudsMA .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.eudsMA .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
.eudsMA .ellipsis:after{content:' … ';}/*!sc*/
.eudsMA .collapsible{margin-left:2em;}/*!sc*/
.eudsMA .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.eudsMA .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
.eudsMA .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.eudsMA .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.eudsMA ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.eudsMA li{position:relative;display:block;}/*!sc*/
.eudsMA .hoverable{display:inline-block;}/*!sc*/
.eudsMA .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.eudsMA .collapsed>.collapsible{display:none;}/*!sc*/
.eudsMA .ellipsis{display:none;}/*!sc*/
.eudsMA .collapsed>.ellipsis{display:inherit;}/*!sc*/
data-styled.g50[id="sc-eRJQtA"]{content:"eudsMA,"}/*!sc*/
.caaBgn{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g51[id="sc-bFwXsg"]{content:"caaBgn,"}/*!sc*/
.TqlOY{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g52[id="sc-fUPiRJ"]{content:"TqlOY,"}/*!sc*/
.fpFYoG{position:relative;}/*!sc*/
data-styled.g53[id="sc-bXYrjy"]{content:"fpFYoG,"}/*!sc*/
.geRSZU{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
.geRSZU label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
.geRSZU:hover,.geRSZU:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
data-styled.g54[id="sc-gnqCJb"]{content:"geRSZU,"}/*!sc*/
.kuvBhH{margin-top:15px;}/*!sc*/
data-styled.g56[id="sc-bgpKpp"]{content:"kuvBhH,"}/*!sc*/
.fmWEAp.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
.fmWEAp button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
.fmWEAp button:focus{font-weight:600;}/*!sc*/
.fmWEAp .sc-dibcMh{height:1.1em;width:1.1em;}/*!sc*/
.fmWEAp .sc-dibcMh polygon{fill:#666;}/*!sc*/
data-styled.g57[id="sc-iyUCga"]{content:"fmWEAp,"}/*!sc*/
.eyIabj{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g58[id="sc-byRegH"]{content:"eyIabj,"}/*!sc*/
.jGdyyu{color:rgba(102,102,102,0.9);}/*!sc*/
data-styled.g59[id="sc-budtlk"]{content:"jGdyyu,"}/*!sc*/
.fcQkkm{color:#666;}/*!sc*/
data-styled.g60[id="sc-fJvEKN"]{content:"fcQkkm,"}/*!sc*/
.iZVMho{color:#666;word-break:break-word;}/*!sc*/
data-styled.g61[id="sc-hsXxFb"]{content:"iZVMho,"}/*!sc*/
.iUhYwd{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g62[id="sc-isZTFa"]{content:"iUhYwd,"}/*!sc*/
.ewbVMc{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g66[id="sc-dEAvcG"]{content:"ewbVMc,"}/*!sc*/
.gqMqVY{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g68[id="sc-fYNhqQ"]{content:"gqMqVY,"}/*!sc*/
.eSQudw:after{content:' and ';font-weight:normal;}/*!sc*/
.eSQudw:last-child:after{content:none;}/*!sc*/
.eSQudw a{text-decoration:auto;color:#32329f;}/*!sc*/
.eSQudw a:visited{color:#32329f;}/*!sc*/
.eSQudw a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g81[id="sc-hFPzkB"]{content:"eSQudw,"}/*!sc*/
.WPZDV{white-space:nowrap;}/*!sc*/
.WPZDV:after{content:' or ';white-space:pre;}/*!sc*/
.WPZDV:last-child:after,.WPZDV:only-child:after{content:none;}/*!sc*/
.WPZDV a{text-decoration:auto;color:#32329f;}/*!sc*/
.WPZDV a:visited{color:#32329f;}/*!sc*/
.WPZDV a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g82[id="sc-iFRVkA"]{content:"WPZDV,"}/*!sc*/
.gqqgtC{flex:1 1 auto;cursor:pointer;}/*!sc*/
data-styled.g83[id="sc-ilCyfT"]{content:"gqqgtC,"}/*!sc*/
.dNXpfB{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
@media screen and (max-width: 50rem){.dNXpfB{margin-top:10px;}}/*!sc*/
data-styled.g84[id="sc-jlEUfS"]{content:"dNXpfB,"}/*!sc*/
.jefPco{display:inline-block;margin:0;}/*!sc*/
data-styled.g85[id="sc-gUMLBR"]{content:"jefPco,"}/*!sc*/
.iaIgja{width:100%;display:flex;margin:1em 0;flex-direction:row;}/*!sc*/
@media screen and (max-width: 50rem){.iaIgja{flex-direction:column;}}/*!sc*/
data-styled.g86[id="sc-hUPhBQ"]{content:"iaIgja,"}/*!sc*/
.hLxGCH{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g92[id="sc-jxDJBN"]{content:"hLxGCH,"}/*!sc*/
.kfVmAL{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.kfVmAL.get{background-color:#2F8132;}/*!sc*/
.kfVmAL.post{background-color:#186FAF;}/*!sc*/
.kfVmAL.put{background-color:#95507c;}/*!sc*/
.kfVmAL.options{background-color:#947014;}/*!sc*/
.kfVmAL.patch{background-color:#bf581d;}/*!sc*/
.kfVmAL.delete{background-color:#cc3333;}/*!sc*/
.kfVmAL.basic{background-color:#707070;}/*!sc*/
.kfVmAL.link{background-color:#07818F;}/*!sc*/
.kfVmAL.head{background-color:#A23DAD;}/*!sc*/
.kfVmAL.hook{background-color:#32329f;}/*!sc*/
.kfVmAL.schema{background-color:#707070;}/*!sc*/
data-styled.g100[id="sc-jsGcFV"]{content:"kfVmAL,"}/*!sc*/
.bquqCV{margin:0;padding:0;}/*!sc*/
.bquqCV:first-child{padding-bottom:32px;}/*!sc*/
.sc-FhnSQ .sc-FhnSQ{font-size:0.929em;}/*!sc*/
.jtzvEg{margin:0;padding:0;display:none;}/*!sc*/
.jtzvEg:first-child{padding-bottom:32px;}/*!sc*/
.sc-FhnSQ .sc-FhnSQ{font-size:0.929em;}/*!sc*/
data-styled.g101[id="sc-FhnSQ"]{content:"bquqCV,jtzvEg,"}/*!sc*/
.dsPLkk{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g102[id="sc-cwcSVF"]{content:"dsPLkk,"}/*!sc*/
.cNpcJW{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
.cNpcJW:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
.cNpcJW .sc-dibcMh{height:1.5em;width:1.5em;}/*!sc*/
.cNpcJW .sc-dibcMh polygon{fill:#333333;}/*!sc*/
.bqKYCQ{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
.bqKYCQ:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.bqKYCQ .sc-dibcMh{height:1.5em;width:1.5em;}/*!sc*/
.bqKYCQ .sc-dibcMh polygon{fill:#333333;}/*!sc*/
data-styled.g103[id="sc-fuBaRS"]{content:"cNpcJW,bqKYCQ,"}/*!sc*/
.dsZUKj{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g104[id="sc-hlwFUH"]{content:"dsZUKj,"}/*!sc*/
.eVjdzv{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
.eVjdzv a,.eVjdzv a:visited,.eVjdzv a:hover{color:#333333!important;padding:5px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
.eVjdzv img{width:15px;margin-right:5px;}/*!sc*/
@media screen and (max-width: 50rem){.eVjdzv{width:100%;}}/*!sc*/
data-styled.g105[id="sc-kXtNZI"]{content:"eVjdzv,"}/*!sc*/
.cgvUrj{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g111[id="sc-eUzzst"]{content:"cgvUrj,"}/*!sc*/
.hgvsuc{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g112[id="sc-jgoAos"]{content:"hgvsuc,"}/*!sc*/
.ecNgtW{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:flex;white-space:nowrap;align-items:center;border:1px solid transparent;border-bottom:0;transition:border-color 0.25s ease;}/*!sc*/
.ecNgtW ..sc-jgoAos{color:#ffffff;}/*!sc*/
.ecNgtW:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
data-styled.g113[id="sc-bpAAPv"]{content:"ecNgtW,"}/*!sc*/
.deMhiD{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.bxmdGF{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
data-styled.g114[id="sc-fBpBLu"]{content:"deMhiD,bxmdGF,"}/*!sc*/
.bVkkkk{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g115[id="sc-dXqqap"]{content:"bVkkkk,"}/*!sc*/
.jlEXoB{padding:10px;}/*!sc*/
data-styled.g116[id="sc-ijfqWo"]{content:"jlEXoB,"}/*!sc*/
.zPpwX{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
.zPpwX >span{color:#333333;}/*!sc*/
data-styled.g117[id="sc-srrxr"]{content:"zPpwX,"}/*!sc*/
.dMNSOR{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
data-styled.g118[id="sc-eEgstq"]{content:"dMNSOR,"}/*!sc*/
.gfsyZD{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
.gfsyZD:focus{outline:auto #1d8127;}/*!sc*/
.kdKxoT{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);cursor:default;}/*!sc*/
.kdKxoT:focus{outline:auto #d41f1c;}/*!sc*/
.kdKxoT::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
.kdKxoT:focus{outline:0;}/*!sc*/
data-styled.g120[id="sc-jthNAk"]{content:"gfsyZD,kdKxoT,"}/*!sc*/
.ecXPYN{vertical-align:top;}/*!sc*/
data-styled.g123[id="sc-eOObWA"]{content:"ecXPYN,"}/*!sc*/
.jWGRrJ{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g124[id="sc-gSVmdp"]{content:"jWGRrJ,"}/*!sc*/
.dpoYnd{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
data-styled.g130[id="sc-doJfcP"]{content:"dpoYnd,"}/*!sc*/
.eMcOhX{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width: 50rem){.eMcOhX{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.eMcOhX{display:none;}}/*!sc*/
data-styled.g131[id="sc-fnaTjL"]{content:"eMcOhX,"}/*!sc*/
.Flmyj{outline:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width: 50rem){.Flmyj{display:flex;}}/*!sc*/
.Flmyj svg{color:#0065FB;}/*!sc*/
@media print{.Flmyj{display:none;}}/*!sc*/
data-styled.g132[id="sc-jyPUfK"]{content:"Flmyj,"}/*!sc*/
.ePGUxG{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
.ePGUxG *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
data-styled.g133[id="sc-JNBUd"]{content:"ePGUxG,"}/*!sc*/
.bDhhVR{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width: 50rem){.bDhhVR{width:100%;}}/*!sc*/
data-styled.g134[id="sc-eVCCQc"]{content:"bDhhVR,"}/*!sc*/
.haiOeP{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width: 75rem){.haiOeP{display:none;}}/*!sc*/
data-styled.g135[id="sc-epRJRH"]{content:"haiOeP,"}/*!sc*/
.jbjAuv{padding:5px 0;}/*!sc*/
data-styled.g136[id="sc-iBGKNG"]{content:"jbjAuv,"}/*!sc*/
.jVkBYH{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g137[id="sc-lcacaV"]{content:"jVkBYH,"}/*!sc*/
.gXFsok{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
.gXFsok path{fill:#333333;}/*!sc*/
data-styled.g138[id="sc-dYttxY"]{content:"gXFsok,"}/*!sc*/
</style>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<div id="redoc"><div class="sc-JNBUd ePGUxG redoc-wrap"><div class="sc-fnaTjL eMcOhX menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iBGKNG jbjAuv"><svg class="sc-dYttxY gXFsok search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-lcacaV jVkBYH search-input" value=""/></div><div class="sc-epGxBs dkdAtf scrollbar-container undefined"><ul role="menu" class="sc-FhnSQ bquqCV"><li tabindex="0" depth="1" data-item-id="tag/Scalytics-API" role="menuitem" aria-label="Scalytics API" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS cNpcJW -depth1"><span width="calc(100% - 38px)" title="Scalytics API" class="sc-hlwFUH dsZUKj">Scalytics API</span><svg class="sc-dibcMh bnalXq" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-FhnSQ jtzvEg"><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1models/get" role="menuitem" aria-label="Lists the models available to the authenticated user." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="get" class="sc-jsGcFV kfVmAL operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Lists the models available to the authenticated user.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1chat~1completions/post" role="menuitem" aria-label="Creates a model response for the given chat conversation using the configured local model." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Creates a model response for the given chat conversation using the configured local model.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1deepsearch/post" role="menuitem" aria-label="Initiates a Deep Search task and streams results via Server-Sent Events (SSE)." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Initiates a Deep Search task and streams results via Server-Sent Events (SSE).</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post" role="menuitem" aria-label="Generates embeddings for a list of text strings." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Generates embeddings for a list of text strings.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1vector~1documents/post" role="menuitem" aria-label="Adds a list of documents to the vector store." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Adds a list of documents to the vector store.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1vector~1search/post" role="menuitem" aria-label="Searches vector documents based on a query text." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Searches vector documents based on a query text.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post" role="menuitem" aria-label="Deletes all vector documents associated with a specific group ID." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Deletes all vector documents associated with a specific group ID.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scalytics-API/paths/~1v1~1images~1generations/post" role="menuitem" aria-label="Creates an image given a prompt." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Creates an image given a prompt.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Vector-Service" role="menuitem" aria-label="Vector Service" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS cNpcJW -depth1"><span width="calc(100% - 38px)" title="Vector Service" class="sc-hlwFUH dsZUKj">Vector Service</span><svg class="sc-dibcMh bnalXq" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-FhnSQ jtzvEg"><li tabindex="0" depth="2" data-item-id="tag/Vector-Service/paths/~1v1~1vector~1embeddings/post" role="menuitem" aria-label="Generates embeddings for a list of text strings." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Generates embeddings for a list of text strings.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vector-Service/paths/~1v1~1vector~1documents/post" role="menuitem" aria-label="Adds a list of documents to the vector store." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Adds a list of documents to the vector store.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vector-Service/paths/~1v1~1vector~1search/post" role="menuitem" aria-label="Searches vector documents based on a query text." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Searches vector documents based on a query text.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post" role="menuitem" aria-label="Deletes all vector documents associated with a specific group ID." aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="post" class="sc-jsGcFV kfVmAL operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Deletes all vector documents associated with a specific group ID.</span></label></li></ul></li></ul><div class="sc-kXtNZI eVjdzv"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-jyPUfK Flmyj"><div class="sc-doJfcP dpoYnd"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg></div></div><div class="sc-eVCCQc bDhhVR api-content"><div class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe api-info"><h1 class="sc-hBDmJg sc-jxDJBN dKykVD hLxGCH">Scalytics Copilot API<!-- --> <span>(<!-- -->4.0.1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><div data-role="redoc-summary" html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><div data-role="redoc-description" html="<p>API documentation for Scalytics Copilot, including the OpenAI-compatible Scalytics API.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>API documentation for Scalytics Copilot, including the OpenAI-compatible Scalytics API.</p>
</div></div></div></div><div id="tag/Scalytics-API" data-section-id="tag/Scalytics-API" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API" aria-label="tag/Scalytics-API"></a>Scalytics API</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>OpenAI-compatible API for local models</p>
"><p>OpenAI-compatible API for local models</p>
</div></div></div><div id="tag/Scalytics-API/paths/~1v1~1models/get" data-section-id="tag/Scalytics-API/paths/~1v1~1models/get" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1models/get" aria-label="tag/Scalytics-API/paths/~1v1~1models/get"></a>Lists the models available to the authenticated user.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>A list of available models.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>A list of available models.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (API globally disabled)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (API globally disabled)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/v1/models</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/models</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174cq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174cq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174cq»0" aria-labelledby="tab«R174cq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"model"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owned_by"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"context_window"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1chat~1completions/post" data-section-id="tag/Scalytics-API/paths/~1v1~1chat~1completions/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1chat~1completions/post" aria-label="tag/Scalytics-API/paths/~1v1~1chat~1completions/post"></a>Creates a model response for the given chat conversation using the configured local model.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="messages" class="sc-kHNKno sc-frmfij sc-iyUCga cDFxGr kNAbAx fmWEAp"><span class="sc-hLyRwt lhCIDE"></span><button aria-label="expand messages"><span class="property-name">messages</span><svg class="sc-dibcMh eVNtOe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">objects</span><span class="sc-byRegH sc-hsXxFb eyIabj iZVMho"> (<!-- -->ChatMessage<!-- -->) </span></div> <div><div html="<p>A list of messages comprising the conversation history.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A list of messages comprising the conversation history.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="stream" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">stream</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">boolean</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">false</span></div> <div><div html="<p>Whether to stream back partial progress.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Whether to stream back partial progress.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="temperature" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">temperature</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">number</span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm"> <!-- --><<!-- -->float<!-- -->><!-- --> </span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 0 .. 2 ]<!-- --> </span></span></div> <div><div html="<p>Controls randomness. Lower values make the output more deterministic.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Controls randomness. Lower values make the output more deterministic.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_tokens" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max_tokens</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>The maximum number of tokens to generate in the completion.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The maximum number of tokens to generate in the completion.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="top_p" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">top_p</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">number</span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm"> <!-- --><<!-- -->float<!-- -->><!-- --> </span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 0 .. 1 ]<!-- --> </span></span></div> <div><div html="<p>Nucleus sampling parameter.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Nucleus sampling parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="frequency_penalty" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">frequency_penalty</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">number</span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm"> <!-- --><<!-- -->float<!-- -->><!-- --> </span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div> <div><div html="<p>Penalizes new tokens based on their existing frequency in the text so far.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Penalizes new tokens based on their existing frequency in the text so far.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="presence_penalty" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">presence_penalty</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">number</span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm"> <!-- --><<!-- -->float<!-- -->><!-- --> </span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div> <div><div html="<p>Penalizes new tokens based on whether they appear in the text so far.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Penalizes new tokens based on whether they appear in the text so far.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="model" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">model</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional ID of the model to use. Currently ignored by the server.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional ID of the model to use. Currently ignored by the server.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="stream_options" class="sc-kHNKno sc-frmfij sc-iyUCga cDFxGr kNAbAx fmWEAp"><span class="sc-hLyRwt lhCIDE"></span><button aria-label="expand stream_options"><span class="property-name">stream_options</span><svg class="sc-dibcMh eVNtOe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">object</span></div> <div><div html="<p>Options for streaming responses.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Options for streaming responses.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns either a completion object or a stream of chunks.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns either a completion object or a stream of chunks.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (API globally disabled)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (API globally disabled)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error (e.g., no local model configured)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error (e.g., no local model configured)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (API globally disabled)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (API globally disabled)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/chat/completions</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/chat/completions</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154kq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154kq»0" aria-labelledby="tab«R154kq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"frequency_penalty"</span>: <span class="token number">-2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"presence_penalty"</span>: <span class="token number">-2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream_options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"include_usage"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174kq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174kq»0" aria-labelledby="tab«R174kq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-cIozSW sc-gnqCJb bJuEgN geRSZU"><svg class="sc-kFXyV egUEEs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chat.completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"choices"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1deepsearch/post" data-section-id="tag/Scalytics-API/paths/~1v1~1deepsearch/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1deepsearch/post" aria-label="tag/Scalytics-API/paths/~1v1~1deepsearch/post"></a>Initiates a Deep Search task and streams results via Server-Sent Events (SSE).<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="query" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">query</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>The user&#39;s initial search query or topic.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The user's initial search query or topic.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="reasoningModelName" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">reasoningModelName</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Required. Name/ID of the LLM for planning and intermediate reasoning. Use GET /v1/models to see available models.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Required. Name/ID of the LLM for planning and intermediate reasoning. Use GET /v1/models to see available models.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="synthesisModelName" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">synthesisModelName</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Required. Name/ID of the LLM for final report synthesis. Use GET /v1/models to see available models.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Required. Name/ID of the LLM for final report synthesis. Use GET /v1/models to see available models.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="search_providers" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">search_providers</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">strings</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">[]</span></div><div><span class="sc-byRegH eyIabj">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"google"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"bing"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"brave"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"openalex"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"wikipedia"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"duckduckgo"</span> </div> <div><div html="<p>Search providers. Defaults to a standard set if not provided.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Search providers. Defaults to a standard set if not provided.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_distinct_search_queries" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max_distinct_search_queries</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">7</span></div> <div><div html="<p>Max distinct search engine queries.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Max distinct search engine queries.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_results_per_provider_query" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max_results_per_provider_query</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">5</span></div> <div><div html="<p>Max search results per provider per query.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Max search results per provider per query.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_url_exploration_depth" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max_url_exploration_depth</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>Max depth for exploring links. Defaults are handled by the Python service configuration.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Max depth for exploring links. Defaults are handled by the Python service configuration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_hops" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max_hops</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>Max research hops/iterations. Defaults are handled by the Python service configuration.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Max research hops/iterations. Defaults are handled by the Python service configuration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="chunk_size_words" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">chunk_size_words</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>Target chunk size in words. Defaults are handled by the Python service configuration.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Target chunk size in words. Defaults are handled by the Python service configuration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="chunk_overlap_words" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">chunk_overlap_words</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>Target chunk overlap in words. Defaults are handled by the Python service configuration.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Target chunk overlap in words. Defaults are handled by the Python service configuration.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="top_k_retrieval_per_hop" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">top_k_retrieval_per_hop</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="<p>Top-K chunks to retrieve from vector store per hop. Defaults are handled by the Python service configuration.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Top-K chunks to retrieve from vector store per hop. Defaults are handled by the Python service configuration.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns a Server-Sent Events (SSE) stream. The stream will contain events like &#39;progress&#39;, &#39;markdown_chunk&#39;, &#39;complete&#39;, &#39;error&#39;, &#39;cancelled&#39;.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns a Server-Sent Events (SSE) stream. The stream will contain events like 'progress', 'markdown_chunk', 'complete', 'error', 'cancelled'.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for Deep Search is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for Deep Search is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/deepsearch</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/deepsearch</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154sq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154sq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154sq»0" aria-labelledby="tab«R154sq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoningModelName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synthesisModelName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"search_providers"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_distinct_search_queries"</span>: <span class="token number">7</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_results_per_provider_query"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_url_exploration_depth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_hops"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunk_size_words"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunk_overlap_words"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_k_retrieval_per_hop"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post" data-section-id="tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post" aria-label="tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post"></a>Generates embeddings for a list of text strings.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="texts" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">texts</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">strings</span></div> <div><div html="<p>A list of text strings to be embedded.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A list of text strings to be embedded.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="model_identifier" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">model_identifier</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional identifier (e.g., ID or name) of the embedding model to use. If None, the service&#39;s default will be used.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional identifier (e.g., ID or name) of the embedding model to use. If None, the service's default will be used.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns the generated embeddings and model information.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns the generated embeddings and model information.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for embeddings is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for embeddings is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/embeddings</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/embeddings</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R1554q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1554q»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1554q»0" aria-labelledby="tab«R1554q»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"texts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"Hello world"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"How are you?"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model_identifier"</span>: <span class="token string">"sentence-transformers/all-MiniLM-L6-v2"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1754q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1754q»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1754q»0" aria-labelledby="tab«R1754q»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeddings"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0.1</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_used"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dimension"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1vector~1documents/post" data-section-id="tag/Scalytics-API/paths/~1v1~1vector~1documents/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1vector~1documents/post" aria-label="tag/Scalytics-API/paths/~1v1~1vector~1documents/post"></a>Adds a list of documents to the vector store.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="documents" class="sc-kHNKno sc-frmfij sc-iyUCga cDFxGr kNAbAx fmWEAp"><span class="sc-hLyRwt lhCIDE"></span><button aria-label="expand documents"><span class="property-name">documents</span><svg class="sc-dibcMh eVNtOe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">objects</span><span class="sc-byRegH sc-hsXxFb eyIabj iZVMho"> (<!-- -->DocumentItemInput<!-- -->) </span></div> <div><div html="<p>A list of document items to add.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A list of document items to add.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>An identifier to group these documents (e.g., user ID, session ID, collection name).</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>An identifier to group these documents (e.g., user ID, session ID, collection name).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Documents processed (check success field for outcome).</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Documents processed (check success field for outcome).</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/documents</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/documents</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155cq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155cq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155cq»0" aria-labelledby="tab«R155cq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"documents"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175cq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175cq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175cq»0" aria-labelledby="tab«R175cq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1vector~1search/post" data-section-id="tag/Scalytics-API/paths/~1v1~1vector~1search/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1vector~1search/post" aria-label="tag/Scalytics-API/paths/~1v1~1vector~1search/post"></a>Searches vector documents based on a query text.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="query_text" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">query_text</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>The text to search for.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The text to search for.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional group ID to scope the search within.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional group ID to scope the search within.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="top_k" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">top_k</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">5</span></div> <div><div html="<p>Number of top results to return.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Number of top results to return.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns search results.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns search results.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/search</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/search</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155kq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155kq»0" aria-labelledby="tab«R155kq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"query_text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_k"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175kq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175kq»0" aria-labelledby="tab«R175kq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distance"</span>: <span class="token number">0.1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"similarity"</span>: <span class="token number">0.1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post" data-section-id="tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post" aria-label="tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post"></a>Deletes all vector documents associated with a specific group ID.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>The ID of the group whose vector documents should be deleted.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The ID of the group whose vector documents should be deleted.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Documents for the group processed for deletion (check success field).</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Documents for the group processed for deletion (check success field).</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid group_id)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid group_id)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/groups/delete</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/groups/delete</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155sq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155sq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155sq»0" aria-labelledby="tab«R155sq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175sq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175sq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175sq»0" aria-labelledby="tab«R175sq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Scalytics-API/paths/~1v1~1images~1generations/post" data-section-id="tag/Scalytics-API/paths/~1v1~1images~1generations/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Scalytics-API/paths/~1v1~1images~1generations/post" aria-label="tag/Scalytics-API/paths/~1v1~1images~1generations/post"></a>Creates an image given a prompt.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="model" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">model</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>ID of the model to use for image generation.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>ID of the model to use for image generation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="prompt" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">prompt</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>A text description of the desired image(s).</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A text description of the desired image(s).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="n" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">n</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">1</span></div> <div><div html="<p>The number of images to generate. (Currently only 1 is supported).</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The number of images to generate. (Currently only 1 is supported).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="size" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">size</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"1024x1024"</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Enum<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"256x256"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"512x512"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"1024x1024"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"1792x1024"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"1024x1792"</span> </div> <div><div html="<p>The size of the generated images.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The size of the generated images.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="response_format" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">response_format</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"b64_json"</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Enum<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"url"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"b64_json"</span> </div> <div><div html="<p>The format in which the generated images are returned.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The format in which the generated images are returned.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns the generated image data.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns the generated image data.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters, model does not support image generation)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters, model does not support image generation)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (API globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (API globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">404<!-- --> </strong><div html="<p>Not Found (Model not found)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Not Found (Model not found)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">501<!-- --> </strong><div html="<p>Not Implemented (Image generation not implemented for the specified provider)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Not Implemented (Image generation not implemented for the specified provider)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/images/generations</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/images/generations</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R1564q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1564q»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1564q»0" aria-labelledby="tab«R1564q»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"n"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"256x256"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"url"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1764q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1764q»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1764q»0" aria-labelledby="tab«R1764q»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"b64_json"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"suggested_filename"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-Service" data-section-id="tag/Vector-Service" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Vector-Service" aria-label="tag/Vector-Service"></a>Vector Service</h2></div></div></div><div id="tag/Vector-Service/paths/~1v1~1vector~1embeddings/post" data-section-id="tag/Vector-Service/paths/~1v1~1vector~1embeddings/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Vector-Service/paths/~1v1~1vector~1embeddings/post" aria-label="tag/Vector-Service/paths/~1v1~1vector~1embeddings/post"></a>Generates embeddings for a list of text strings.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="texts" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">texts</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">strings</span></div> <div><div html="<p>A list of text strings to be embedded.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A list of text strings to be embedded.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="model_identifier" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">model_identifier</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional identifier (e.g., ID or name) of the embedding model to use. If None, the service&#39;s default will be used.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional identifier (e.g., ID or name) of the embedding model to use. If None, the service's default will be used.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns the generated embeddings and model information.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns the generated embeddings and model information.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for embeddings is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for embeddings is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/embeddings</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/embeddings</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Riida»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Riida»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Riida»0" aria-labelledby="tab«Riida»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"texts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"Hello world"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"How are you?"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model_identifier"</span>: <span class="token string">"sentence-transformers/all-MiniLM-L6-v2"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjida»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjida»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjida»0" aria-labelledby="tab«Rjida»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeddings"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0.1</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_used"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dimension"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-Service/paths/~1v1~1vector~1documents/post" data-section-id="tag/Vector-Service/paths/~1v1~1vector~1documents/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Vector-Service/paths/~1v1~1vector~1documents/post" aria-label="tag/Vector-Service/paths/~1v1~1vector~1documents/post"></a>Adds a list of documents to the vector store.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="documents" class="sc-kHNKno sc-frmfij sc-iyUCga cDFxGr kNAbAx fmWEAp"><span class="sc-hLyRwt lhCIDE"></span><button aria-label="expand documents"><span class="property-name">documents</span><svg class="sc-dibcMh eVNtOe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">objects</span><span class="sc-byRegH sc-hsXxFb eyIabj iZVMho"> (<!-- -->DocumentItemInput<!-- -->) </span></div> <div><div html="<p>A list of document items to add.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>A list of document items to add.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>An identifier to group these documents (e.g., user ID, session ID, collection name).</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>An identifier to group these documents (e.g., user ID, session ID, collection name).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Documents processed (check success field for outcome).</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Documents processed (check success field for outcome).</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/documents</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/documents</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Riila»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Riila»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Riila»0" aria-labelledby="tab«Riila»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"documents"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjila»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjila»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjila»0" aria-labelledby="tab«Rjila»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-Service/paths/~1v1~1vector~1search/post" data-section-id="tag/Vector-Service/paths/~1v1~1vector~1search/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Vector-Service/paths/~1v1~1vector~1search/post" aria-label="tag/Vector-Service/paths/~1v1~1vector~1search/post"></a>Searches vector documents based on a query text.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="query_text" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">query_text</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>The text to search for.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The text to search for.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional group ID to scope the search within.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional group ID to scope the search within.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="top_k" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">top_k</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">5</span></div> <div><div html="<p>Number of top results to return.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Number of top results to return.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Returns search results.</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Returns search results.</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid input parameters)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid input parameters)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/search</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/search</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Riita»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Riita»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Riita»0" aria-labelledby="tab«Riita»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"query_text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_k"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjita»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjita»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjita»0" aria-labelledby="tab«Rjita»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distance"</span>: <span class="token number">0.1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"similarity"</span>: <span class="token number">0.1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post" data-section-id="tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post" class="sc-dYOLZc dRVblm"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post" aria-label="tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post"></a>Deletes all vector documents associated with a specific group ID.<!-- --> </h2><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>BearerAuth</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="group_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">group_id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>The ID of the group whose vector documents should be deleted.</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>The ID of the group whose vector documents should be deleted.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>OK. Documents for the group processed for deletion (check success field).</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>OK. Documents for the group processed for deletion (check success field).</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">400<!-- --> </strong><div html="<p>Bad Request (e.g., invalid group_id)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bad Request (e.g., invalid group_id)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized (invalid API key)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized (invalid API key)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">403<!-- --> </strong><div html="<p>Forbidden (Feature globally disabled or insufficient permissions)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Forbidden (Feature globally disabled or insufficient permissions)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">429<!-- --> </strong><div html="<p>Too Many Requests (Rate limit exceeded)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Too Many Requests (Rate limit exceeded)</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">500<!-- --> </strong><div html="<p>Internal Server Error</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Internal Server Error</p>
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">503<!-- --> </strong><div html="<p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Service Unavailable (e.g., Python backend for vector operations is not ready)</p>
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/v1/vector/groups/delete</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Current Server</p>
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Current Server</p>
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span></span>/v1/vector/groups/delete</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Rij5a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rij5a»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rij5a»0" aria-labelledby="tab«Rij5a»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjj5a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjj5a»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjj5a»0" aria-labelledby="tab«Rjj5a»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-epRJRH haiOeP"></div></div></div>
<script>
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Scalytics Copilot API","version":"4.0.1","description":"API documentation for Scalytics Copilot, including the OpenAI-compatible Scalytics API."},"servers":[{"url":"/","description":"Current Server"}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Scalytics API Key"}},"schemas":{"ChatMessage":{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["system","user","assistant"],"description":"The role of the message author."},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["text","image_url"],"description":"The type of the content part."},"text":{"type":"string","description":"The text content, if type is 'text'."},"image_url":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL of the image (http, https, or data URI)."}},"required":["url"],"description":"The image URL details, if type is 'image_url'."}}}}],"description":"The content of the message. Can be a string or an array of content parts (for multimodal input)."}}},"ChatCompletionRequest":{"type":"object","required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"},"description":"A list of messages comprising the conversation history."},"stream":{"type":"boolean","default":false,"description":"Whether to stream back partial progress."},"temperature":{"type":"number","format":"float","minimum":0,"maximum":2,"description":"Controls randomness. Lower values make the output more deterministic."},"max_tokens":{"type":"integer","description":"The maximum number of tokens to generate in the completion."},"top_p":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"Nucleus sampling parameter."},"frequency_penalty":{"type":"number","format":"float","minimum":-2,"maximum":2,"description":"Penalizes new tokens based on their existing frequency in the text so far."},"presence_penalty":{"type":"number","format":"float","minimum":-2,"maximum":2,"description":"Penalizes new tokens based on whether they appear in the text so far."},"model":{"type":"string","description":"Optional ID of the model to use. Currently ignored by the server."},"stream_options":{"type":"object","properties":{"include_usage":{"type":"boolean","description":"If set, reports token usage stats in a final stream chunk before the stream termination."}},"description":"Options for streaming responses."}}},"DeepSearchApiRequest":{"type":"object","required":["query","reasoningModelName","synthesisModelName"],"properties":{"query":{"type":"string","description":"The user's initial search query or topic."},"reasoningModelName":{"type":"string","description":"Required. Name/ID of the LLM for planning and intermediate reasoning. Use GET /v1/models to see available models."},"synthesisModelName":{"type":"string","description":"Required. Name/ID of the LLM for final report synthesis. Use GET /v1/models to see available models."},"search_providers":{"type":"array","items":{"type":"string","enum":["google","bing","brave","openalex","wikipedia","duckduckgo"]},"description":"Search providers. Defaults to a standard set if not provided.","default":[]},"max_distinct_search_queries":{"type":"integer","description":"Max distinct search engine queries.","default":7},"max_results_per_provider_query":{"type":"integer","description":"Max search results per provider per query.","default":5},"max_url_exploration_depth":{"type":"integer","description":"Max depth for exploring links. Defaults are handled by the Python service configuration."},"max_hops":{"type":"integer","description":"Max research hops/iterations. Defaults are handled by the Python service configuration."},"chunk_size_words":{"type":"integer","description":"Target chunk size in words. Defaults are handled by the Python service configuration."},"chunk_overlap_words":{"type":"integer","description":"Target chunk overlap in words. Defaults are handled by the Python service configuration."},"top_k_retrieval_per_hop":{"type":"integer","description":"Top-K chunks to retrieve from vector store per hop. Defaults are handled by the Python service configuration."}}},"EmbedTextsApiRequest":{"type":"object","required":["texts"],"properties":{"texts":{"type":"array","items":{"type":"string"},"description":"A list of text strings to be embedded.","example":["Hello world","How are you?"]},"model_identifier":{"type":"string","description":"Optional identifier (e.g., ID or name) of the embedding model to use. If None, the service's default will be used.","example":"sentence-transformers/all-MiniLM-L6-v2"}}},"EmbedTextsApiResponseData":{"type":"object","properties":{"embeddings":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}},"description":"A list of embedding vectors, corresponding to the input texts."},"model_used":{"type":"string","description":"Identifier of the embedding model that was actually used."},"dimension":{"type":"integer","description":"The dimensionality of the returned embedding vectors."}}},"EmbedTextsApiSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"$ref":"#/components/schemas/EmbedTextsApiResponseData"}}},"DocumentItemInput":{"type":"object","required":["text_content"],"properties":{"id":{"type":"string","description":"Optional unique ID for the document item. If not provided, it might be auto-generated by the backend."},"text_content":{"type":"string","description":"The actual text content to be embedded and stored."},"metadata":{"type":"object","additionalProperties":true,"description":"Arbitrary metadata associated with the document."}}},"AddDocumentsApiRequest":{"type":"object","required":["documents","group_id"],"properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentItemInput"},"description":"A list of document items to add."},"group_id":{"type":"string","description":"An identifier to group these documents (e.g., user ID, session ID, collection name)."}}},"GeneralApiResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the operation was successful."},"message":{"type":"string","description":"A message describing the outcome of the operation."},"details":{"type":"object","additionalProperties":true,"description":"Optional additional details from the operation."}}},"VectorSearchApiRequest":{"type":"object","required":["query_text"],"properties":{"query_text":{"type":"string","description":"The text to search for."},"group_id":{"type":"string","description":"Optional group ID to scope the search within."},"top_k":{"type":"integer","description":"Number of top results to return.","default":5,"minimum":1,"maximum":100}}},"VectorSearchResultItemApi":{"type":"object","properties":{"id":{"type":"string","nullable":true,"description":"ID of the matching document item."},"text_content":{"type":"string","description":"The text content of the matching chunk."},"metadata":{"type":"object","additionalProperties":true,"description":"Metadata of the original document."},"distance":{"type":"number","format":"float","nullable":true,"description":"Distance score from the query vector."},"similarity":{"type":"number","format":"float","nullable":true,"description":"Similarity score."}}},"VectorSearchApiResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the search operation was successful."},"message":{"type":"string","description":"A message describing the outcome of the search."},"results":{"type":"array","items":{"$ref":"#/components/schemas/VectorSearchResultItemApi"},"description":"List of search result items."},"details":{"type":"object","nullable":true,"description":"Optional additional details from the operation."}}},"DeleteVectorGroupApiRequest":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the group whose vector documents should be deleted."}}},"ModelInfo":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the model."},"object":{"type":"string","example":"model","description":"The object type, which is always \"model\"."},"created":{"type":"integer","format":"int64","description":"Unix timestamp of when the model was created or registered."},"owned_by":{"type":"string","description":"Identifier for the owner of the model (e.g., \"system\", \"openai\", provider name)."},"root":{"type":"string","description":"The root model ID, often the same as 'id' for base models."},"parent":{"type":"string","nullable":true,"description":"The parent model ID if this is a fine-tuned model."},"description":{"type":"string","nullable":true,"description":"A description of the model."},"context_window":{"type":"integer","nullable":true,"description":"The context window size for the model."}}},"ModelListApiResponse":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelInfo"}}}}}},"paths":{"/v1/models":{"get":{"summary":"Lists the models available to the authenticated user.","tags":["Scalytics API"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"A list of available models.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelListApiResponse"}}}},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (API globally disabled)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"}}}},"/v1/chat/completions":{"post":{"summary":"Creates a model response for the given chat conversation using the configured local model.","tags":["Scalytics API"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionRequest"}}}},"responses":{"200":{"description":"OK. Returns either a completion object or a stream of chunks.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","example":"chat.completion"},"created":{"type":"integer"},"model":{"type":"string"},"choices":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}},"usage":{"type":"object","properties":{"prompt_tokens":{"type":"integer"},"completion_tokens":{"type":"integer"},"total_tokens":{"type":"integer"}}}}}},"text/event-stream":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","example":"chat.completion.chunk"},"created":{"type":"integer"},"model":{"type":"string"},"choices":{"type":"array","items":{"type":"object","properties":{"delta":{"$ref":"#/components/schemas/ChatMessage"},"finish_reason":{"type":"string","nullable":true}}}},"usage":{"type":"object","nullable":true,"properties":{"prompt_tokens":{"type":"integer"},"completion_tokens":{"type":"integer"},"total_tokens":{"type":"integer"}}}}}}}},"400":{"description":"Bad Request (e.g., invalid input)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (API globally disabled)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error (e.g., no local model configured)"},"503":{"description":"Service Unavailable (API globally disabled)"}}}},"/v1/deepsearch":{"post":{"summary":"Initiates a Deep Search task and streams results via Server-Sent Events (SSE).","tags":["Scalytics API"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeepSearchApiRequest"}}}},"responses":{"200":{"description":"OK. Returns a Server-Sent Events (SSE) stream. The stream will contain events like 'progress', 'markdown_chunk', 'complete', 'error', 'cancelled'.","content":{"text/event-stream":{"schema":{"type":"string","example":"event: progress\ndata: {\"stage\":\"planning\",\"message\":\"Generating research plan...\"}\n\nevent: markdown_chunk\ndata: {\"chunk_id\":0,\"content\":\"This is a part of the report.\"}\n\nevent: complete\ndata: {\"message\":\"Research completed successfully.\"}\n"}}}},"400":{"description":"Bad Request (e.g., invalid input parameters)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (Feature globally disabled or insufficient permissions)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable (e.g., Python backend for Deep Search is not ready)"}}}},"/v1/vector/embeddings":{"post":{"summary":"Generates embeddings for a list of text strings.","tags":["Scalytics API","Vector Service"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTextsApiRequest"}}}},"responses":{"200":{"description":"OK. Returns the generated embeddings and model information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTextsApiSuccessResponse"}}}},"400":{"description":"Bad Request (e.g., invalid input parameters)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (Feature globally disabled or insufficient permissions)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable (e.g., Python backend for embeddings is not ready)"}}}},"/v1/vector/documents":{"post":{"summary":"Adds a list of documents to the vector store.","tags":["Scalytics API","Vector Service"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDocumentsApiRequest"}}}},"responses":{"200":{"description":"OK. Documents processed (check success field for outcome).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralApiResponse"}}}},"400":{"description":"Bad Request (e.g., invalid input parameters)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (Feature globally disabled or insufficient permissions)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable (e.g., Python backend for vector operations is not ready)"}}}},"/v1/vector/search":{"post":{"summary":"Searches vector documents based on a query text.","tags":["Scalytics API","Vector Service"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorSearchApiRequest"}}}},"responses":{"200":{"description":"OK. Returns search results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorSearchApiResponse"}}}},"400":{"description":"Bad Request (e.g., invalid input parameters)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (Feature globally disabled or insufficient permissions)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable (e.g., Python backend for vector operations is not ready)"}}}},"/v1/vector/groups/delete":{"post":{"summary":"Deletes all vector documents associated with a specific group ID.","tags":["Scalytics API","Vector Service"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVectorGroupApiRequest"}}}},"responses":{"200":{"description":"OK. Documents for the group processed for deletion (check success field).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralApiResponse"}}}},"400":{"description":"Bad Request (e.g., invalid group_id)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (Feature globally disabled or insufficient permissions)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable (e.g., Python backend for vector operations is not ready)"}}}},"/v1/images/generations":{"post":{"summary":"Creates an image given a prompt.","tags":["Scalytics API"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","prompt"],"properties":{"model":{"type":"string","description":"ID of the model to use for image generation."},"prompt":{"type":"string","description":"A text description of the desired image(s)."},"n":{"type":"integer","default":1,"description":"The number of images to generate. (Currently only 1 is supported)."},"size":{"type":"string","default":"1024x1024","enum":["256x256","512x512","1024x1024","1792x1024","1024x1792"],"description":"The size of the generated images."},"response_format":{"type":"string","default":"b64_json","enum":["url","b64_json"],"description":"The format in which the generated images are returned."}}}}}},"responses":{"200":{"description":"OK. Returns the generated image data.","content":{"application/json":{"schema":{"type":"object","properties":{"created":{"type":"integer","format":"int64","description":"Unix timestamp of when the image was created."},"data":{"type":"array","items":{"type":"object","properties":{"b64_json":{"type":"string","format":"byte","description":"The base64-encoded JSON of the generated image, if response_format is 'b64_json'."},"url":{"type":"string","format":"uri","description":"The URL of the generated image, if response_format is 'url'."},"suggested_filename":{"type":"string","description":"A suggested filename for the generated image (e.g., 'my-prompt-image.png')."}}}}}}}}},"400":{"description":"Bad Request (e.g., invalid input parameters, model does not support image generation)"},"401":{"description":"Unauthorized (invalid API key)"},"403":{"description":"Forbidden (API globally disabled or insufficient permissions)"},"404":{"description":"Not Found (Model not found)"},"429":{"description":"Too Many Requests (Rate limit exceeded)"},"500":{"description":"Internal Server Error"},"501":{"description":"Not Implemented (Image generation not implemented for the specified provider)"}}}}},"tags":[{"name":"Scalytics API","description":"OpenAI-compatible API for local models"}]}},"searchIndex":{"store":["tag/Scalytics-API","tag/Scalytics-API/paths/~1v1~1models/get","tag/Scalytics-API/paths/~1v1~1chat~1completions/post","tag/Scalytics-API/paths/~1v1~1deepsearch/post","tag/Scalytics-API/paths/~1v1~1vector~1embeddings/post","tag/Scalytics-API/paths/~1v1~1vector~1documents/post","tag/Scalytics-API/paths/~1v1~1vector~1search/post","tag/Scalytics-API/paths/~1v1~1vector~1groups~1delete/post","tag/Scalytics-API/paths/~1v1~1images~1generations/post","tag/Vector-Service","tag/Vector-Service/paths/~1v1~1vector~1embeddings/post","tag/Vector-Service/paths/~1v1~1vector~1documents/post","tag/Vector-Service/paths/~1v1~1vector~1search/post","tag/Vector-Service/paths/~1v1~1vector~1groups~1delete/post"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.129,1,2.435]],["description/0",[1,0.886,2,1.138,3,0.886,4,0.719]],["title/1",[4,1.526,5,1.052,6,2.415,7,2.415,8,2.415]],["description/1",[9,2.427]],["title/2",[3,1.362,4,1.644,10,1.362,11,1.75,12,1.362,13,1.75,14,1.75,15,1.75,16,1.75]],["description/2",[17,2.427]],["title/3",[18,1.75,19,1.75,20,1.106,21,1.75,22,1.75,23,1.75,24,1.75,25,1.75,26,1.75,27,1.75]],["description/3",[28,2.427]],["title/4",[5,1.052,29,1.879,30,1.879,31,1.263,32,1.879]],["description/4",[33,1.888]],["title/5",[5,1.052,34,1.879,35,0.877,36,0.727,37,1.879]],["description/5",[38,1.888]],["title/6",[20,1.419,31,1.174,35,0.815,36,0.676,39,1.747,40,1.747]],["description/6",[41,1.888]],["title/7",[35,0.761,36,0.631,42,1.631,43,1.631,44,1.631,45,1.631,46,1.631]],["description/7",[47,1.888]],["title/8",[10,2.034,12,2.034,48,2.614,49,2.614]],["description/8",[50,2.427]],["title/9",[36,0.942,51,3.129]],["description/9",[]],["title/10",[5,1.052,29,1.879,30,1.879,31,1.263,32,1.879]],["description/10",[33,1.888]],["title/11",[5,1.052,34,1.879,35,0.877,36,0.727,37,1.879]],["description/11",[38,1.888]],["title/12",[20,1.419,31,1.174,35,0.815,36,0.676,39,1.747,40,1.747]],["description/12",[41,1.888]],["title/13",[35,0.761,36,0.631,42,1.631,43,1.631,44,1.631,45,1.631,46,1.631]],["description/13",[47,1.888]]],"invertedIndex":[["add",{"_index":34,"title":{"5":{},"11":{}},"description":{}}],["api",{"_index":1,"title":{"0":{}},"description":{"0":{}}}],["associ",{"_index":43,"title":{"7":{},"13":{}},"description":{}}],["authent",{"_index":7,"title":{"1":{}},"description":{}}],["avail",{"_index":6,"title":{"1":{}},"description":{}}],["base",{"_index":39,"title":{"6":{},"12":{}},"description":{}}],["chat",{"_index":13,"title":{"2":{}},"description":{}}],["configur",{"_index":16,"title":{"2":{}},"description":{}}],["convers",{"_index":14,"title":{"2":{}},"description":{}}],["creat",{"_index":10,"title":{"2":{},"8":{}},"description":{}}],["deep",{"_index":19,"title":{"3":{}},"description":{}}],["delet",{"_index":42,"title":{"7":{},"13":{}},"description":{}}],["document",{"_index":35,"title":{"5":{},"6":{},"7":{},"11":{},"12":{},"13":{}},"description":{}}],["embed",{"_index":30,"title":{"4":{},"10":{}},"description":{}}],["event",{"_index":26,"title":{"3":{}},"description":{}}],["gener",{"_index":29,"title":{"4":{},"10":{}},"description":{}}],["given",{"_index":12,"title":{"2":{},"8":{}},"description":{}}],["group",{"_index":45,"title":{"7":{},"13":{}},"description":{}}],["id",{"_index":46,"title":{"7":{},"13":{}},"description":{}}],["imag",{"_index":48,"title":{"8":{}},"description":{}}],["initi",{"_index":18,"title":{"3":{}},"description":{}}],["list",{"_index":5,"title":{"1":{},"4":{},"5":{},"10":{},"11":{}},"description":{}}],["local",{"_index":3,"title":{"2":{}},"description":{"0":{}}}],["model",{"_index":4,"title":{"1":{},"2":{}},"description":{"0":{}}}],["openai-compat",{"_index":2,"title":{},"description":{"0":{}}}],["prompt",{"_index":49,"title":{"8":{}},"description":{}}],["queri",{"_index":40,"title":{"6":{},"12":{}},"description":{}}],["respons",{"_index":11,"title":{"2":{}},"description":{}}],["result",{"_index":23,"title":{"3":{}},"description":{}}],["scalyt",{"_index":0,"title":{"0":{}},"description":{}}],["search",{"_index":20,"title":{"3":{},"6":{},"12":{}},"description":{}}],["server-s",{"_index":25,"title":{"3":{}},"description":{}}],["servic",{"_index":51,"title":{"9":{}},"description":{}}],["specif",{"_index":44,"title":{"7":{},"13":{}},"description":{}}],["sse",{"_index":27,"title":{"3":{}},"description":{}}],["store",{"_index":37,"title":{"5":{},"11":{}},"description":{}}],["stream",{"_index":22,"title":{"3":{}},"description":{}}],["string",{"_index":32,"title":{"4":{},"10":{}},"description":{}}],["task",{"_index":21,"title":{"3":{}},"description":{}}],["text",{"_index":31,"title":{"4":{},"6":{},"10":{},"12":{}},"description":{}}],["us",{"_index":15,"title":{"2":{}},"description":{}}],["user",{"_index":8,"title":{"1":{}},"description":{}}],["v1/chat/complet",{"_index":17,"title":{},"description":{"2":{}}}],["v1/deepsearch",{"_index":28,"title":{},"description":{"3":{}}}],["v1/images/gener",{"_index":50,"title":{},"description":{"8":{}}}],["v1/model",{"_index":9,"title":{},"description":{"1":{}}}],["v1/vector/docu",{"_index":38,"title":{},"description":{"5":{},"11":{}}}],["v1/vector/embed",{"_index":33,"title":{},"description":{"4":{},"10":{}}}],["v1/vector/groups/delet",{"_index":47,"title":{},"description":{"7":{},"13":{}}}],["v1/vector/search",{"_index":41,"title":{},"description":{"6":{},"12":{}}}],["vector",{"_index":36,"title":{"5":{},"6":{},"7":{},"9":{},"11":{},"12":{},"13":{}},"description":{}}],["via",{"_index":24,"title":{"3":{}},"description":{}}]],"pipeline":[]}},"options":{}};
var container = document.getElementById('redoc');
Redoc.hydrate(__redoc_state, container);
</script>
</body>
</html>