ScuttleBot

scuttlebot / reference / api / index.html
Source Rendered
Blame History Raw 2806 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="Agent coordination backplane built on IRC">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://scuttlebot.dev/reference/api/">
16
17
18
<link rel="prev" href="../../architecture/persistence/">
19
20
21
<link rel="next" href="../cli/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
29
30
31
32
<title>HTTP API - scuttlebot</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/css/custom.css">
59
60
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#http-api-reference" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="scuttlebot" class="md-header__button md-logo" aria-label="scuttlebot" data-md-component="logo">
100
101
<img src="../../assets/images/conflict-logo.svg" alt="logo">
102
103
</a>
104
<label class="md-header__button md-icon" for="__drawer">
105
106
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
107
</label>
108
<div class="md-header__title" data-md-component="header-title">
109
<div class="md-header__ellipsis">
110
<div class="md-header__topic">
111
<span class="md-ellipsis">
112
scuttlebot
113
</span>
114
</div>
115
<div class="md-header__topic" data-md-component="header-topic">
116
<span class="md-ellipsis">
117
118
HTTP API
119
120
</span>
121
</div>
122
</div>
123
</div>
124
125
126
<form class="md-header__option" data-md-component="palette">
127
128
129
130
131
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
132
133
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
134
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
135
</label>
136
137
138
139
140
141
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
142
143
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
144
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
145
</label>
146
147
148
</form>
149
150
151
152
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
153
154
155
156
157
158
<label class="md-header__button md-icon" for="__search">
159
160
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
161
</label>
162
<div class="md-search" data-md-component="search" role="dialog">
163
<label class="md-search__overlay" for="__search"></label>
164
<div class="md-search__inner" role="search">
165
<form class="md-search__form" name="search">
166
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
167
<label class="md-search__icon md-icon" for="__search">
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
172
</label>
173
<nav class="md-search__options" aria-label="Search">
174
175
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
176
177
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
178
</button>
179
</nav>
180
181
<div class="md-search__suggest" data-md-component="search-suggest"></div>
182
183
</form>
184
<div class="md-search__output">
185
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
186
<div class="md-search-result" data-md-component="search-result">
187
<div class="md-search-result__meta">
188
Initializing search
189
</div>
190
<ol class="md-search-result__list" role="presentation"></ol>
191
</div>
192
</div>
193
</div>
194
</div>
195
</div>
196
197
198
199
<div class="md-header__source">
200
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
201
<div class="md-source__icon md-icon">
202
203
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
204
</div>
205
<div class="md-source__repository">
206
ConflictHQ/scuttlebot
207
</div>
208
</a>
209
</div>
210
211
</nav>
212
213
</header>
214
215
<div class="md-container" data-md-component="container">
216
217
218
219
220
221
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
222
<div class="md-grid">
223
<ul class="md-tabs__list">
224
225
226
227
228
229
230
<li class="md-tabs__item">
231
<a href="../.." class="md-tabs__link">
232
233
234
235
236
237
Home
238
239
</a>
240
</li>
241
242
243
244
245
246
247
248
249
250
251
<li class="md-tabs__item">
252
<a href="../../getting-started/installation/" class="md-tabs__link">
253
254
255
256
Getting Started
257
258
</a>
259
</li>
260
261
262
263
264
265
266
267
268
269
270
271
<li class="md-tabs__item">
272
<a href="../../guide/agent-registration/" class="md-tabs__link">
273
274
275
276
Guide
277
278
</a>
279
</li>
280
281
282
283
284
285
286
287
288
289
290
291
<li class="md-tabs__item">
292
<a href="../../architecture/overview/" class="md-tabs__link">
293
294
295
296
Architecture
297
298
</a>
299
</li>
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<li class="md-tabs__item md-tabs__item--active">
314
<a href="./" class="md-tabs__link">
315
316
317
318
Reference
319
320
</a>
321
</li>
322
323
324
325
326
327
328
329
330
331
<li class="md-tabs__item">
332
<a href="../../contributing/" class="md-tabs__link">
333
334
335
336
337
338
Contributing
339
340
</a>
341
</li>
342
343
344
345
</ul>
346
</div>
347
</nav>
348
349
350
351
<main class="md-main" data-md-component="main">
352
<div class="md-main__inner md-grid">
353
354
355
356
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
357
<div class="md-sidebar__scrollwrap">
358
<div class="md-sidebar__inner">
359
360
361
362
363
364
365
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
366
<label class="md-nav__title" for="__drawer">
367
<a href="../.." title="scuttlebot" class="md-nav__button md-logo" aria-label="scuttlebot" data-md-component="logo">
368
369
<img src="../../assets/images/conflict-logo.svg" alt="logo">
370
371
</a>
372
scuttlebot
373
</label>
374
375
<div class="md-nav__source">
376
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
377
<div class="md-source__icon md-icon">
378
379
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
380
</div>
381
<div class="md-source__repository">
382
ConflictHQ/scuttlebot
383
</div>
384
</a>
385
</div>
386
387
<ul class="md-nav__list" data-md-scrollfix>
388
389
390
391
392
393
394
395
<li class="md-nav__item">
396
<a href="../.." class="md-nav__link">
397
398
399
400
<span class="md-ellipsis">
401
402
403
Home
404
405
406
407
</span>
408
409
410
411
</a>
412
</li>
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<li class="md-nav__item md-nav__item--nested">
433
434
435
436
437
438
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
439
440
441
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
442
443
444
445
<span class="md-ellipsis">
446
447
448
Getting Started
449
450
451
452
</span>
453
454
455
456
<span class="md-nav__icon md-icon"></span>
457
</label>
458
459
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
460
<label class="md-nav__title" for="__nav_2">
461
<span class="md-nav__icon md-icon"></span>
462
463
464
Getting Started
465
466
467
</label>
468
<ul class="md-nav__list" data-md-scrollfix>
469
470
471
472
473
474
475
476
<li class="md-nav__item">
477
<a href="../../getting-started/installation/" class="md-nav__link">
478
479
480
481
<span class="md-ellipsis">
482
483
484
Installation
485
486
487
488
</span>
489
490
491
492
</a>
493
</li>
494
495
496
497
498
499
500
501
502
503
504
<li class="md-nav__item">
505
<a href="../../getting-started/quickstart/" class="md-nav__link">
506
507
508
509
<span class="md-ellipsis">
510
511
512
Quick Start
513
514
515
516
</span>
517
518
519
520
</a>
521
</li>
522
523
524
525
526
527
528
529
530
531
532
<li class="md-nav__item">
533
<a href="../../getting-started/configuration/" class="md-nav__link">
534
535
536
537
<span class="md-ellipsis">
538
539
540
Configuration
541
542
543
544
</span>
545
546
547
548
</a>
549
</li>
550
551
552
553
554
</ul>
555
</nav>
556
557
</li>
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<li class="md-nav__item md-nav__item--nested">
578
579
580
581
582
583
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
584
585
586
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
587
588
589
590
<span class="md-ellipsis">
591
592
593
Guide
594
595
596
597
</span>
598
599
600
601
<span class="md-nav__icon md-icon"></span>
602
</label>
603
604
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
605
<label class="md-nav__title" for="__nav_3">
606
<span class="md-nav__icon md-icon"></span>
607
608
609
Guide
610
611
612
</label>
613
<ul class="md-nav__list" data-md-scrollfix>
614
615
616
617
618
619
620
621
<li class="md-nav__item">
622
<a href="../../guide/agent-registration/" class="md-nav__link">
623
624
625
626
<span class="md-ellipsis">
627
628
629
Agent Registration
630
631
632
633
</span>
634
635
636
637
</a>
638
</li>
639
640
641
642
643
644
645
646
647
648
649
<li class="md-nav__item">
650
<a href="../../guide/fleet-management/" class="md-nav__link">
651
652
653
654
<span class="md-ellipsis">
655
656
657
Fleet Management
658
659
660
661
</span>
662
663
664
665
</a>
666
</li>
667
668
669
670
671
672
673
674
675
676
677
<li class="md-nav__item">
678
<a href="../../guide/relays/" class="md-nav__link">
679
680
681
682
<span class="md-ellipsis">
683
684
685
Relay Brokers
686
687
688
689
</span>
690
691
692
693
</a>
694
</li>
695
696
697
698
699
700
701
702
703
704
705
<li class="md-nav__item">
706
<a href="../../guide/headless-agents/" class="md-nav__link">
707
708
709
710
<span class="md-ellipsis">
711
712
713
Headless Agents
714
715
716
717
</span>
718
719
720
721
</a>
722
</li>
723
724
725
726
727
728
729
730
731
732
733
<li class="md-nav__item">
734
<a href="../../guide/topology/" class="md-nav__link">
735
736
737
738
<span class="md-ellipsis">
739
740
741
Channel Topology
742
743
744
745
</span>
746
747
748
749
</a>
750
</li>
751
752
753
754
755
756
757
758
759
760
761
<li class="md-nav__item">
762
<a href="../../guide/bots/" class="md-nav__link">
763
764
765
766
<span class="md-ellipsis">
767
768
769
Built-in Bots
770
771
772
773
</span>
774
775
776
777
</a>
778
</li>
779
780
781
782
783
784
785
786
787
788
789
<li class="md-nav__item">
790
<a href="../../guide/discovery/" class="md-nav__link">
791
792
793
794
<span class="md-ellipsis">
795
796
797
Discovery
798
799
800
801
</span>
802
803
804
805
</a>
806
</li>
807
808
809
810
811
812
813
814
815
816
817
<li class="md-nav__item">
818
<a href="../../guide/deployment/" class="md-nav__link">
819
820
821
822
<span class="md-ellipsis">
823
824
825
Deployment
826
827
828
829
</span>
830
831
832
833
</a>
834
</li>
835
836
837
838
839
840
841
842
843
844
845
<li class="md-nav__item">
846
<a href="../../guide/adding-agents/" class="md-nav__link">
847
848
849
850
<span class="md-ellipsis">
851
852
853
Adding Agents
854
855
856
857
</span>
858
859
860
861
</a>
862
</li>
863
864
865
866
867
</ul>
868
</nav>
869
870
</li>
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
<li class="md-nav__item md-nav__item--nested">
891
892
893
894
895
896
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
897
898
899
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
900
901
902
903
<span class="md-ellipsis">
904
905
906
Architecture
907
908
909
910
</span>
911
912
913
914
<span class="md-nav__icon md-icon"></span>
915
</label>
916
917
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
918
<label class="md-nav__title" for="__nav_4">
919
<span class="md-nav__icon md-icon"></span>
920
921
922
Architecture
923
924
925
</label>
926
<ul class="md-nav__list" data-md-scrollfix>
927
928
929
930
931
932
933
934
<li class="md-nav__item">
935
<a href="../../architecture/overview/" class="md-nav__link">
936
937
938
939
<span class="md-ellipsis">
940
941
942
Overview
943
944
945
946
</span>
947
948
949
950
</a>
951
</li>
952
953
954
955
956
957
958
959
960
961
962
<li class="md-nav__item">
963
<a href="../../architecture/why-irc/" class="md-nav__link">
964
965
966
967
<span class="md-ellipsis">
968
969
970
Why IRC
971
972
973
974
</span>
975
976
977
978
</a>
979
</li>
980
981
982
983
984
985
986
987
988
989
990
<li class="md-nav__item">
991
<a href="../../architecture/wire-format/" class="md-nav__link">
992
993
994
995
<span class="md-ellipsis">
996
997
998
Wire Format
999
1000
1001
1002
</span>
1003
1004
1005
1006
</a>
1007
</li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
<li class="md-nav__item">
1019
<a href="../../architecture/persistence/" class="md-nav__link">
1020
1021
1022
1023
<span class="md-ellipsis">
1024
1025
1026
Persistence
1027
1028
1029
1030
</span>
1031
1032
1033
1034
</a>
1035
</li>
1036
1037
1038
1039
1040
</ul>
1041
</nav>
1042
1043
</li>
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
1069
1070
1071
1072
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1073
1074
1075
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
1076
1077
1078
1079
<span class="md-ellipsis">
1080
1081
1082
Reference
1083
1084
1085
1086
</span>
1087
1088
1089
1090
<span class="md-nav__icon md-icon"></span>
1091
</label>
1092
1093
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1094
<label class="md-nav__title" for="__nav_5">
1095
<span class="md-nav__icon md-icon"></span>
1096
1097
1098
Reference
1099
1100
1101
</label>
1102
<ul class="md-nav__list" data-md-scrollfix>
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
<li class="md-nav__item md-nav__item--active">
1113
1114
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1115
1116
1117
1118
1119
1120
<label class="md-nav__link md-nav__link--active" for="__toc">
1121
1122
1123
1124
<span class="md-ellipsis">
1125
1126
1127
HTTP API
1128
1129
1130
1131
</span>
1132
1133
1134
1135
<span class="md-nav__icon md-icon"></span>
1136
</label>
1137
1138
<a href="./" class="md-nav__link md-nav__link--active">
1139
1140
1141
1142
<span class="md-ellipsis">
1143
1144
1145
HTTP API
1146
1147
1148
1149
</span>
1150
1151
1152
1153
</a>
1154
1155
1156
1157
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1158
1159
1160
1161
1162
1163
1164
<label class="md-nav__title" for="__toc">
1165
<span class="md-nav__icon md-icon"></span>
1166
Table of contents
1167
</label>
1168
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1169
1170
<li class="md-nav__item">
1171
<a href="#authentication" class="md-nav__link">
1172
<span class="md-ellipsis">
1173
1174
Authentication
1175
1176
</span>
1177
</a>
1178
1179
<nav class="md-nav" aria-label="Authentication">
1180
<ul class="md-nav__list">
1181
1182
<li class="md-nav__item">
1183
<a href="#login-admin-ui" class="md-nav__link">
1184
<span class="md-ellipsis">
1185
1186
Login (admin UI)
1187
1188
</span>
1189
</a>
1190
1191
</li>
1192
1193
</ul>
1194
</nav>
1195
1196
</li>
1197
1198
<li class="md-nav__item">
1199
<a href="#status" class="md-nav__link">
1200
<span class="md-ellipsis">
1201
1202
Status
1203
1204
</span>
1205
</a>
1206
1207
<nav class="md-nav" aria-label="Status">
1208
<ul class="md-nav__list">
1209
1210
<li class="md-nav__item">
1211
<a href="#get-v1status" class="md-nav__link">
1212
<span class="md-ellipsis">
1213
1214
GET /v1/status
1215
1216
</span>
1217
</a>
1218
1219
</li>
1220
1221
<li class="md-nav__item">
1222
<a href="#get-v1metrics" class="md-nav__link">
1223
<span class="md-ellipsis">
1224
1225
GET /v1/metrics
1226
1227
</span>
1228
</a>
1229
1230
</li>
1231
1232
</ul>
1233
</nav>
1234
1235
</li>
1236
1237
<li class="md-nav__item">
1238
<a href="#settings" class="md-nav__link">
1239
<span class="md-ellipsis">
1240
1241
Settings
1242
1243
</span>
1244
</a>
1245
1246
<nav class="md-nav" aria-label="Settings">
1247
<ul class="md-nav__list">
1248
1249
<li class="md-nav__item">
1250
<a href="#get-v1settings" class="md-nav__link">
1251
<span class="md-ellipsis">
1252
1253
GET /v1/settings
1254
1255
</span>
1256
</a>
1257
1258
</li>
1259
1260
<li class="md-nav__item">
1261
<a href="#get-v1settingspolicies" class="md-nav__link">
1262
<span class="md-ellipsis">
1263
1264
GET /v1/settings/policies
1265
1266
</span>
1267
</a>
1268
1269
</li>
1270
1271
<li class="md-nav__item">
1272
<a href="#put-v1settingspolicies" class="md-nav__link">
1273
<span class="md-ellipsis">
1274
1275
PUT /v1/settings/policies
1276
1277
</span>
1278
</a>
1279
1280
</li>
1281
1282
</ul>
1283
</nav>
1284
1285
</li>
1286
1287
<li class="md-nav__item">
1288
<a href="#agents" class="md-nav__link">
1289
<span class="md-ellipsis">
1290
1291
Agents
1292
1293
</span>
1294
</a>
1295
1296
<nav class="md-nav" aria-label="Agents">
1297
<ul class="md-nav__list">
1298
1299
<li class="md-nav__item">
1300
<a href="#get-v1agents" class="md-nav__link">
1301
<span class="md-ellipsis">
1302
1303
GET /v1/agents
1304
1305
</span>
1306
</a>
1307
1308
</li>
1309
1310
<li class="md-nav__item">
1311
<a href="#get-v1agentsnick" class="md-nav__link">
1312
<span class="md-ellipsis">
1313
1314
GET /v1/agents/{nick}
1315
1316
</span>
1317
</a>
1318
1319
</li>
1320
1321
<li class="md-nav__item">
1322
<a href="#post-v1agentsregister" class="md-nav__link">
1323
<span class="md-ellipsis">
1324
1325
POST /v1/agents/register
1326
1327
</span>
1328
</a>
1329
1330
</li>
1331
1332
<li class="md-nav__item">
1333
<a href="#post-v1agentsnickrotate" class="md-nav__link">
1334
<span class="md-ellipsis">
1335
1336
POST /v1/agents/{nick}/rotate
1337
1338
</span>
1339
</a>
1340
1341
</li>
1342
1343
<li class="md-nav__item">
1344
<a href="#post-v1agentsnickadopt" class="md-nav__link">
1345
<span class="md-ellipsis">
1346
1347
POST /v1/agents/{nick}/adopt
1348
1349
</span>
1350
</a>
1351
1352
</li>
1353
1354
<li class="md-nav__item">
1355
<a href="#post-v1agentsnickrevoke" class="md-nav__link">
1356
<span class="md-ellipsis">
1357
1358
POST /v1/agents/{nick}/revoke
1359
1360
</span>
1361
</a>
1362
1363
</li>
1364
1365
<li class="md-nav__item">
1366
<a href="#delete-v1agentsnick" class="md-nav__link">
1367
<span class="md-ellipsis">
1368
1369
DELETE /v1/agents/{nick}
1370
1371
</span>
1372
</a>
1373
1374
</li>
1375
1376
</ul>
1377
</nav>
1378
1379
</li>
1380
1381
<li class="md-nav__item">
1382
<a href="#channels" class="md-nav__link">
1383
<span class="md-ellipsis">
1384
1385
Channels
1386
1387
</span>
1388
</a>
1389
1390
<nav class="md-nav" aria-label="Channels">
1391
<ul class="md-nav__list">
1392
1393
<li class="md-nav__item">
1394
<a href="#get-v1channels" class="md-nav__link">
1395
<span class="md-ellipsis">
1396
1397
GET /v1/channels
1398
1399
</span>
1400
</a>
1401
1402
</li>
1403
1404
<li class="md-nav__item">
1405
<a href="#post-v1channelschanneljoin" class="md-nav__link">
1406
<span class="md-ellipsis">
1407
1408
POST /v1/channels/{channel}/join
1409
1410
</span>
1411
</a>
1412
1413
</li>
1414
1415
<li class="md-nav__item">
1416
<a href="#delete-v1channelschannel" class="md-nav__link">
1417
<span class="md-ellipsis">
1418
1419
DELETE /v1/channels/{channel}
1420
1421
</span>
1422
</a>
1423
1424
</li>
1425
1426
<li class="md-nav__item">
1427
<a href="#get-v1channelschannelmessages" class="md-nav__link">
1428
<span class="md-ellipsis">
1429
1430
GET /v1/channels/{channel}/messages
1431
1432
</span>
1433
</a>
1434
1435
</li>
1436
1437
<li class="md-nav__item">
1438
<a href="#get-v1channelschannelstream" class="md-nav__link">
1439
<span class="md-ellipsis">
1440
1441
GET /v1/channels/{channel}/stream
1442
1443
</span>
1444
</a>
1445
1446
</li>
1447
1448
<li class="md-nav__item">
1449
<a href="#post-v1channelschannelmessages" class="md-nav__link">
1450
<span class="md-ellipsis">
1451
1452
POST /v1/channels/{channel}/messages
1453
1454
</span>
1455
</a>
1456
1457
</li>
1458
1459
<li class="md-nav__item">
1460
<a href="#post-v1channelschannelpresence" class="md-nav__link">
1461
<span class="md-ellipsis">
1462
1463
POST /v1/channels/{channel}/presence
1464
1465
</span>
1466
</a>
1467
1468
</li>
1469
1470
<li class="md-nav__item">
1471
<a href="#get-v1channelschannelusers" class="md-nav__link">
1472
<span class="md-ellipsis">
1473
1474
GET /v1/channels/{channel}/users
1475
1476
</span>
1477
</a>
1478
1479
</li>
1480
1481
</ul>
1482
</nav>
1483
1484
</li>
1485
1486
<li class="md-nav__item">
1487
<a href="#admins" class="md-nav__link">
1488
<span class="md-ellipsis">
1489
1490
Admins
1491
1492
</span>
1493
</a>
1494
1495
<nav class="md-nav" aria-label="Admins">
1496
<ul class="md-nav__list">
1497
1498
<li class="md-nav__item">
1499
<a href="#get-v1admins" class="md-nav__link">
1500
<span class="md-ellipsis">
1501
1502
GET /v1/admins
1503
1504
</span>
1505
</a>
1506
1507
</li>
1508
1509
<li class="md-nav__item">
1510
<a href="#post-v1admins" class="md-nav__link">
1511
<span class="md-ellipsis">
1512
1513
POST /v1/admins
1514
1515
</span>
1516
</a>
1517
1518
</li>
1519
1520
<li class="md-nav__item">
1521
<a href="#delete-v1adminsusername" class="md-nav__link">
1522
<span class="md-ellipsis">
1523
1524
DELETE /v1/admins/{username}
1525
1526
</span>
1527
</a>
1528
1529
</li>
1530
1531
<li class="md-nav__item">
1532
<a href="#put-v1adminsusernamepassword" class="md-nav__link">
1533
<span class="md-ellipsis">
1534
1535
PUT /v1/admins/{username}/password
1536
1537
</span>
1538
</a>
1539
1540
</li>
1541
1542
</ul>
1543
</nav>
1544
1545
</li>
1546
1547
<li class="md-nav__item">
1548
<a href="#llm-backends" class="md-nav__link">
1549
<span class="md-ellipsis">
1550
1551
LLM Backends
1552
1553
</span>
1554
</a>
1555
1556
<nav class="md-nav" aria-label="LLM Backends">
1557
<ul class="md-nav__list">
1558
1559
<li class="md-nav__item">
1560
<a href="#get-v1llmbackends" class="md-nav__link">
1561
<span class="md-ellipsis">
1562
1563
GET /v1/llm/backends
1564
1565
</span>
1566
</a>
1567
1568
</li>
1569
1570
<li class="md-nav__item">
1571
<a href="#post-v1llmbackends" class="md-nav__link">
1572
<span class="md-ellipsis">
1573
1574
POST /v1/llm/backends
1575
1576
</span>
1577
</a>
1578
1579
</li>
1580
1581
<li class="md-nav__item">
1582
<a href="#put-v1llmbackendsname" class="md-nav__link">
1583
<span class="md-ellipsis">
1584
1585
PUT /v1/llm/backends/{name}
1586
1587
</span>
1588
</a>
1589
1590
</li>
1591
1592
<li class="md-nav__item">
1593
<a href="#delete-v1llmbackendsname" class="md-nav__link">
1594
<span class="md-ellipsis">
1595
1596
DELETE /v1/llm/backends/{name}
1597
1598
</span>
1599
</a>
1600
1601
</li>
1602
1603
<li class="md-nav__item">
1604
<a href="#get-v1llmbackendsnamemodels" class="md-nav__link">
1605
<span class="md-ellipsis">
1606
1607
GET /v1/llm/backends/{name}/models
1608
1609
</span>
1610
</a>
1611
1612
</li>
1613
1614
<li class="md-nav__item">
1615
<a href="#post-v1llmdiscover" class="md-nav__link">
1616
<span class="md-ellipsis">
1617
1618
POST /v1/llm/discover
1619
1620
</span>
1621
</a>
1622
1623
</li>
1624
1625
<li class="md-nav__item">
1626
<a href="#get-v1llmknown" class="md-nav__link">
1627
<span class="md-ellipsis">
1628
1629
GET /v1/llm/known
1630
1631
</span>
1632
</a>
1633
1634
</li>
1635
1636
<li class="md-nav__item">
1637
<a href="#post-v1llmcomplete" class="md-nav__link">
1638
<span class="md-ellipsis">
1639
1640
POST /v1/llm/complete
1641
1642
</span>
1643
</a>
1644
1645
</li>
1646
1647
</ul>
1648
</nav>
1649
1650
</li>
1651
1652
<li class="md-nav__item">
1653
<a href="#error-responses" class="md-nav__link">
1654
<span class="md-ellipsis">
1655
1656
Error responses
1657
1658
</span>
1659
</a>
1660
1661
</li>
1662
1663
</ul>
1664
1665
</nav>
1666
1667
</li>
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
<li class="md-nav__item">
1679
<a href="../cli/" class="md-nav__link">
1680
1681
1682
1683
<span class="md-ellipsis">
1684
1685
1686
CLI (scuttlectl)
1687
1688
1689
1690
</span>
1691
1692
1693
1694
</a>
1695
</li>
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
<li class="md-nav__item">
1707
<a href="../config/" class="md-nav__link">
1708
1709
1710
1711
<span class="md-ellipsis">
1712
1713
1714
Config Schema
1715
1716
1717
1718
</span>
1719
1720
1721
1722
</a>
1723
</li>
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
<li class="md-nav__item">
1735
<a href="../message-types/" class="md-nav__link">
1736
1737
1738
1739
<span class="md-ellipsis">
1740
1741
1742
Message Types
1743
1744
1745
1746
</span>
1747
1748
1749
1750
</a>
1751
</li>
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
<li class="md-nav__item">
1763
<a href="../mcp/" class="md-nav__link">
1764
1765
1766
1767
<span class="md-ellipsis">
1768
1769
1770
MCP Server
1771
1772
1773
1774
</span>
1775
1776
1777
1778
</a>
1779
</li>
1780
1781
1782
1783
1784
</ul>
1785
</nav>
1786
1787
</li>
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
<li class="md-nav__item">
1798
<a href="../../contributing/" class="md-nav__link">
1799
1800
1801
1802
<span class="md-ellipsis">
1803
1804
1805
Contributing
1806
1807
1808
1809
</span>
1810
1811
1812
1813
</a>
1814
</li>
1815
1816
1817
1818
</ul>
1819
</nav>
1820
</div>
1821
</div>
1822
</div>
1823
1824
1825
1826
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1827
<div class="md-sidebar__scrollwrap">
1828
<div class="md-sidebar__inner">
1829
1830
1831
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1832
1833
1834
1835
1836
1837
1838
<label class="md-nav__title" for="__toc">
1839
<span class="md-nav__icon md-icon"></span>
1840
Table of contents
1841
</label>
1842
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1843
1844
<li class="md-nav__item">
1845
<a href="#authentication" class="md-nav__link">
1846
<span class="md-ellipsis">
1847
1848
Authentication
1849
1850
</span>
1851
</a>
1852
1853
<nav class="md-nav" aria-label="Authentication">
1854
<ul class="md-nav__list">
1855
1856
<li class="md-nav__item">
1857
<a href="#login-admin-ui" class="md-nav__link">
1858
<span class="md-ellipsis">
1859
1860
Login (admin UI)
1861
1862
</span>
1863
</a>
1864
1865
</li>
1866
1867
</ul>
1868
</nav>
1869
1870
</li>
1871
1872
<li class="md-nav__item">
1873
<a href="#status" class="md-nav__link">
1874
<span class="md-ellipsis">
1875
1876
Status
1877
1878
</span>
1879
</a>
1880
1881
<nav class="md-nav" aria-label="Status">
1882
<ul class="md-nav__list">
1883
1884
<li class="md-nav__item">
1885
<a href="#get-v1status" class="md-nav__link">
1886
<span class="md-ellipsis">
1887
1888
GET /v1/status
1889
1890
</span>
1891
</a>
1892
1893
</li>
1894
1895
<li class="md-nav__item">
1896
<a href="#get-v1metrics" class="md-nav__link">
1897
<span class="md-ellipsis">
1898
1899
GET /v1/metrics
1900
1901
</span>
1902
</a>
1903
1904
</li>
1905
1906
</ul>
1907
</nav>
1908
1909
</li>
1910
1911
<li class="md-nav__item">
1912
<a href="#settings" class="md-nav__link">
1913
<span class="md-ellipsis">
1914
1915
Settings
1916
1917
</span>
1918
</a>
1919
1920
<nav class="md-nav" aria-label="Settings">
1921
<ul class="md-nav__list">
1922
1923
<li class="md-nav__item">
1924
<a href="#get-v1settings" class="md-nav__link">
1925
<span class="md-ellipsis">
1926
1927
GET /v1/settings
1928
1929
</span>
1930
</a>
1931
1932
</li>
1933
1934
<li class="md-nav__item">
1935
<a href="#get-v1settingspolicies" class="md-nav__link">
1936
<span class="md-ellipsis">
1937
1938
GET /v1/settings/policies
1939
1940
</span>
1941
</a>
1942
1943
</li>
1944
1945
<li class="md-nav__item">
1946
<a href="#put-v1settingspolicies" class="md-nav__link">
1947
<span class="md-ellipsis">
1948
1949
PUT /v1/settings/policies
1950
1951
</span>
1952
</a>
1953
1954
</li>
1955
1956
</ul>
1957
</nav>
1958
1959
</li>
1960
1961
<li class="md-nav__item">
1962
<a href="#agents" class="md-nav__link">
1963
<span class="md-ellipsis">
1964
1965
Agents
1966
1967
</span>
1968
</a>
1969
1970
<nav class="md-nav" aria-label="Agents">
1971
<ul class="md-nav__list">
1972
1973
<li class="md-nav__item">
1974
<a href="#get-v1agents" class="md-nav__link">
1975
<span class="md-ellipsis">
1976
1977
GET /v1/agents
1978
1979
</span>
1980
</a>
1981
1982
</li>
1983
1984
<li class="md-nav__item">
1985
<a href="#get-v1agentsnick" class="md-nav__link">
1986
<span class="md-ellipsis">
1987
1988
GET /v1/agents/{nick}
1989
1990
</span>
1991
</a>
1992
1993
</li>
1994
1995
<li class="md-nav__item">
1996
<a href="#post-v1agentsregister" class="md-nav__link">
1997
<span class="md-ellipsis">
1998
1999
POST /v1/agents/register
2000
2001
</span>
2002
</a>
2003
2004
</li>
2005
2006
<li class="md-nav__item">
2007
<a href="#post-v1agentsnickrotate" class="md-nav__link">
2008
<span class="md-ellipsis">
2009
2010
POST /v1/agents/{nick}/rotate
2011
2012
</span>
2013
</a>
2014
2015
</li>
2016
2017
<li class="md-nav__item">
2018
<a href="#post-v1agentsnickadopt" class="md-nav__link">
2019
<span class="md-ellipsis">
2020
2021
POST /v1/agents/{nick}/adopt
2022
2023
</span>
2024
</a>
2025
2026
</li>
2027
2028
<li class="md-nav__item">
2029
<a href="#post-v1agentsnickrevoke" class="md-nav__link">
2030
<span class="md-ellipsis">
2031
2032
POST /v1/agents/{nick}/revoke
2033
2034
</span>
2035
</a>
2036
2037
</li>
2038
2039
<li class="md-nav__item">
2040
<a href="#delete-v1agentsnick" class="md-nav__link">
2041
<span class="md-ellipsis">
2042
2043
DELETE /v1/agents/{nick}
2044
2045
</span>
2046
</a>
2047
2048
</li>
2049
2050
</ul>
2051
</nav>
2052
2053
</li>
2054
2055
<li class="md-nav__item">
2056
<a href="#channels" class="md-nav__link">
2057
<span class="md-ellipsis">
2058
2059
Channels
2060
2061
</span>
2062
</a>
2063
2064
<nav class="md-nav" aria-label="Channels">
2065
<ul class="md-nav__list">
2066
2067
<li class="md-nav__item">
2068
<a href="#get-v1channels" class="md-nav__link">
2069
<span class="md-ellipsis">
2070
2071
GET /v1/channels
2072
2073
</span>
2074
</a>
2075
2076
</li>
2077
2078
<li class="md-nav__item">
2079
<a href="#post-v1channelschanneljoin" class="md-nav__link">
2080
<span class="md-ellipsis">
2081
2082
POST /v1/channels/{channel}/join
2083
2084
</span>
2085
</a>
2086
2087
</li>
2088
2089
<li class="md-nav__item">
2090
<a href="#delete-v1channelschannel" class="md-nav__link">
2091
<span class="md-ellipsis">
2092
2093
DELETE /v1/channels/{channel}
2094
2095
</span>
2096
</a>
2097
2098
</li>
2099
2100
<li class="md-nav__item">
2101
<a href="#get-v1channelschannelmessages" class="md-nav__link">
2102
<span class="md-ellipsis">
2103
2104
GET /v1/channels/{channel}/messages
2105
2106
</span>
2107
</a>
2108
2109
</li>
2110
2111
<li class="md-nav__item">
2112
<a href="#get-v1channelschannelstream" class="md-nav__link">
2113
<span class="md-ellipsis">
2114
2115
GET /v1/channels/{channel}/stream
2116
2117
</span>
2118
</a>
2119
2120
</li>
2121
2122
<li class="md-nav__item">
2123
<a href="#post-v1channelschannelmessages" class="md-nav__link">
2124
<span class="md-ellipsis">
2125
2126
POST /v1/channels/{channel}/messages
2127
2128
</span>
2129
</a>
2130
2131
</li>
2132
2133
<li class="md-nav__item">
2134
<a href="#post-v1channelschannelpresence" class="md-nav__link">
2135
<span class="md-ellipsis">
2136
2137
POST /v1/channels/{channel}/presence
2138
2139
</span>
2140
</a>
2141
2142
</li>
2143
2144
<li class="md-nav__item">
2145
<a href="#get-v1channelschannelusers" class="md-nav__link">
2146
<span class="md-ellipsis">
2147
2148
GET /v1/channels/{channel}/users
2149
2150
</span>
2151
</a>
2152
2153
</li>
2154
2155
</ul>
2156
</nav>
2157
2158
</li>
2159
2160
<li class="md-nav__item">
2161
<a href="#admins" class="md-nav__link">
2162
<span class="md-ellipsis">
2163
2164
Admins
2165
2166
</span>
2167
</a>
2168
2169
<nav class="md-nav" aria-label="Admins">
2170
<ul class="md-nav__list">
2171
2172
<li class="md-nav__item">
2173
<a href="#get-v1admins" class="md-nav__link">
2174
<span class="md-ellipsis">
2175
2176
GET /v1/admins
2177
2178
</span>
2179
</a>
2180
2181
</li>
2182
2183
<li class="md-nav__item">
2184
<a href="#post-v1admins" class="md-nav__link">
2185
<span class="md-ellipsis">
2186
2187
POST /v1/admins
2188
2189
</span>
2190
</a>
2191
2192
</li>
2193
2194
<li class="md-nav__item">
2195
<a href="#delete-v1adminsusername" class="md-nav__link">
2196
<span class="md-ellipsis">
2197
2198
DELETE /v1/admins/{username}
2199
2200
</span>
2201
</a>
2202
2203
</li>
2204
2205
<li class="md-nav__item">
2206
<a href="#put-v1adminsusernamepassword" class="md-nav__link">
2207
<span class="md-ellipsis">
2208
2209
PUT /v1/admins/{username}/password
2210
2211
</span>
2212
</a>
2213
2214
</li>
2215
2216
</ul>
2217
</nav>
2218
2219
</li>
2220
2221
<li class="md-nav__item">
2222
<a href="#llm-backends" class="md-nav__link">
2223
<span class="md-ellipsis">
2224
2225
LLM Backends
2226
2227
</span>
2228
</a>
2229
2230
<nav class="md-nav" aria-label="LLM Backends">
2231
<ul class="md-nav__list">
2232
2233
<li class="md-nav__item">
2234
<a href="#get-v1llmbackends" class="md-nav__link">
2235
<span class="md-ellipsis">
2236
2237
GET /v1/llm/backends
2238
2239
</span>
2240
</a>
2241
2242
</li>
2243
2244
<li class="md-nav__item">
2245
<a href="#post-v1llmbackends" class="md-nav__link">
2246
<span class="md-ellipsis">
2247
2248
POST /v1/llm/backends
2249
2250
</span>
2251
</a>
2252
2253
</li>
2254
2255
<li class="md-nav__item">
2256
<a href="#put-v1llmbackendsname" class="md-nav__link">
2257
<span class="md-ellipsis">
2258
2259
PUT /v1/llm/backends/{name}
2260
2261
</span>
2262
</a>
2263
2264
</li>
2265
2266
<li class="md-nav__item">
2267
<a href="#delete-v1llmbackendsname" class="md-nav__link">
2268
<span class="md-ellipsis">
2269
2270
DELETE /v1/llm/backends/{name}
2271
2272
</span>
2273
</a>
2274
2275
</li>
2276
2277
<li class="md-nav__item">
2278
<a href="#get-v1llmbackendsnamemodels" class="md-nav__link">
2279
<span class="md-ellipsis">
2280
2281
GET /v1/llm/backends/{name}/models
2282
2283
</span>
2284
</a>
2285
2286
</li>
2287
2288
<li class="md-nav__item">
2289
<a href="#post-v1llmdiscover" class="md-nav__link">
2290
<span class="md-ellipsis">
2291
2292
POST /v1/llm/discover
2293
2294
</span>
2295
</a>
2296
2297
</li>
2298
2299
<li class="md-nav__item">
2300
<a href="#get-v1llmknown" class="md-nav__link">
2301
<span class="md-ellipsis">
2302
2303
GET /v1/llm/known
2304
2305
</span>
2306
</a>
2307
2308
</li>
2309
2310
<li class="md-nav__item">
2311
<a href="#post-v1llmcomplete" class="md-nav__link">
2312
<span class="md-ellipsis">
2313
2314
POST /v1/llm/complete
2315
2316
</span>
2317
</a>
2318
2319
</li>
2320
2321
</ul>
2322
</nav>
2323
2324
</li>
2325
2326
<li class="md-nav__item">
2327
<a href="#error-responses" class="md-nav__link">
2328
<span class="md-ellipsis">
2329
2330
Error responses
2331
2332
</span>
2333
</a>
2334
2335
</li>
2336
2337
</ul>
2338
2339
</nav>
2340
</div>
2341
</div>
2342
</div>
2343
2344
2345
2346
<div class="md-content" data-md-component="content">
2347
2348
<article class="md-content__inner md-typeset">
2349
2350
2351
2352
2353
2354
2355
2356
2357
<h1 id="http-api-reference">HTTP API Reference<a class="headerlink" href="#http-api-reference" title="Permanent link">&para;</a></h1>
2358
<p>scuttlebot exposes a REST API at the address configured in <code>api_addr</code> (default <code>127.0.0.1:8080</code>).</p>
2359
<p>All <code>/v1/</code> endpoints require a valid <strong>Bearer token</strong> in the <code>Authorization</code> header, except for the SSE stream endpoint which uses a <code>?token=</code> query parameter (browser <code>EventSource</code> cannot send headers).</p>
2360
<p>The API token is written to <code>data/ergo/api_token</code> on every daemon start.</p>
2361
<hr />
2362
<h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h2>
2363
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="err">Authorization: Bearer &lt;token&gt;</span>
2364
</code></pre></div>
2365
<p>All <code>/v1/</code> requests must include this header. Requests without a valid token return <code>401 Unauthorized</code>.</p>
2366
<h3 id="login-admin-ui">Login (admin UI)<a class="headerlink" href="#login-admin-ui" title="Permanent link">&para;</a></h3>
2367
<p>Human operators log in via the web UI. Sessions are cookie-based and separate from the Bearer token.</p>
2368
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">POST /login</span>
2369
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="err">Content-Type: application/json</span>
2370
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
2371
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="err">{&quot;username&quot;: &quot;admin&quot;, &quot;password&quot;: &quot;...&quot;}</span>
2372
</code></pre></div>
2373
<p><strong>Responses:</strong></p>
2374
<table>
2375
<thead>
2376
<tr>
2377
<th>Status</th>
2378
<th>Meaning</th>
2379
</tr>
2380
</thead>
2381
<tbody>
2382
<tr>
2383
<td><code>200 OK</code></td>
2384
<td>Login successful; session cookie set</td>
2385
</tr>
2386
<tr>
2387
<td><code>401 Unauthorized</code></td>
2388
<td>Invalid credentials</td>
2389
</tr>
2390
<tr>
2391
<td><code>429 Too Many Requests</code></td>
2392
<td>Rate limit exceeded (10 attempts / 15 min per IP)</td>
2393
</tr>
2394
</tbody>
2395
</table>
2396
<hr />
2397
<h2 id="status">Status<a class="headerlink" href="#status" title="Permanent link">&para;</a></h2>
2398
<h3 id="get-v1status"><code>GET /v1/status</code><a class="headerlink" href="#get-v1status" title="Permanent link">&para;</a></h3>
2399
<p>Returns daemon health, uptime, and agent count.</p>
2400
<p><strong>Response <code>200 OK</code>:</strong></p>
2401
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
2402
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ok&quot;</span><span class="p">,</span>
2403
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">&quot;uptime&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2h14m&quot;</span><span class="p">,</span>
2404
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">&quot;agents&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
2405
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">&quot;started&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2026-04-01T10:00:00Z&quot;</span>
2406
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="p">}</span>
2407
</code></pre></div>
2408
<hr />
2409
<h3 id="get-v1metrics"><code>GET /v1/metrics</code><a class="headerlink" href="#get-v1metrics" title="Permanent link">&para;</a></h3>
2410
<p>Returns Prometheus-style metrics.</p>
2411
<p><strong>Response <code>200 OK</code>:</strong> plain text Prometheus exposition format.</p>
2412
<hr />
2413
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
2414
<p>Settings endpoints are available when the daemon is started with a policy store.</p>
2415
<h3 id="get-v1settings"><code>GET /v1/settings</code><a class="headerlink" href="#get-v1settings" title="Permanent link">&para;</a></h3>
2416
<p>Returns all current settings and policies.</p>
2417
<p><strong>Response <code>200 OK</code>:</strong></p>
2418
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
2419
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">&quot;policies&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
2420
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">&quot;oracle&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">&quot;enabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;backend&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;anthropic&quot;</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">},</span>
2421
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">&quot;scribe&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">&quot;enabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">}</span>
2422
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="p">}</span>
2423
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="p">}</span>
2424
</code></pre></div>
2425
<hr />
2426
<h3 id="get-v1settingspolicies"><code>GET /v1/settings/policies</code><a class="headerlink" href="#get-v1settingspolicies" title="Permanent link">&para;</a></h3>
2427
<p>Returns the current bot policy configuration.</p>
2428
<p><strong>Response <code>200 OK</code>:</strong> policy object (same as <code>settings.policies</code>).</p>
2429
<hr />
2430
<h3 id="put-v1settingspolicies"><code>PUT /v1/settings/policies</code><a class="headerlink" href="#put-v1settingspolicies" title="Permanent link">&para;</a></h3>
2431
<p>Replaces the bot policy configuration.</p>
2432
<p><strong>Request body:</strong> full or partial policy object.</p>
2433
<p><strong>Response <code>200 OK</code>:</strong> updated policy object.</p>
2434
<hr />
2435
<h2 id="agents">Agents<a class="headerlink" href="#agents" title="Permanent link">&para;</a></h2>
2436
<h3 id="get-v1agents"><code>GET /v1/agents</code><a class="headerlink" href="#get-v1agents" title="Permanent link">&para;</a></h3>
2437
<p>List all registered agents.</p>
2438
<p><strong>Response <code>200 OK</code>:</strong></p>
2439
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p">[</span>
2440
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="p">{</span>
2441
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
2442
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker&quot;</span><span class="p">,</span>
2443
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="nt">&quot;channels&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;#general&quot;</span><span class="p">],</span>
2444
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="nt">&quot;revoked&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
2445
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span><span class="p">}</span>
2446
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="p">]</span>
2447
</code></pre></div>
2448
<hr />
2449
<h3 id="get-v1agentsnick"><code>GET /v1/agents/{nick}</code><a class="headerlink" href="#get-v1agentsnick" title="Permanent link">&para;</a></h3>
2450
<p>Get a single agent by nick.</p>
2451
<p><strong>Response <code>200 OK</code>:</strong></p>
2452
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>
2453
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
2454
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker&quot;</span><span class="p">,</span>
2455
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="nt">&quot;channels&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;#general&quot;</span><span class="p">],</span>
2456
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">&quot;revoked&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
2457
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="p">}</span>
2458
</code></pre></div>
2459
<p><strong>Response <code>404 Not Found</code>:</strong> agent does not exist.</p>
2460
<hr />
2461
<h3 id="post-v1agentsregister"><code>POST /v1/agents/register</code><a class="headerlink" href="#post-v1agentsregister" title="Permanent link">&para;</a></h3>
2462
<p>Register a new agent. Returns credentials — <strong>the passphrase is returned once and never stored in plaintext</strong>.</p>
2463
<p><strong>Request body:</strong></p>
2464
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="p">{</span>
2465
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker-001&quot;</span><span class="p">,</span>
2466
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker&quot;</span><span class="p">,</span>
2467
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span><span class="nt">&quot;channels&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;general&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;ops&quot;</span><span class="p">]</span>
2468
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="p">}</span>
2469
</code></pre></div>
2470
<table>
2471
<thead>
2472
<tr>
2473
<th>Field</th>
2474
<th>Type</th>
2475
<th>Required</th>
2476
<th>Description</th>
2477
</tr>
2478
</thead>
2479
<tbody>
2480
<tr>
2481
<td><code>nick</code></td>
2482
<td>string</td>
2483
<td>yes</td>
2484
<td>IRC nick — must be unique, IRC-safe</td>
2485
</tr>
2486
<tr>
2487
<td><code>type</code></td>
2488
<td>string</td>
2489
<td>no</td>
2490
<td><code>worker</code> (default), <code>orchestrator</code>, or <code>observer</code></td>
2491
</tr>
2492
<tr>
2493
<td><code>channels</code></td>
2494
<td>[]string</td>
2495
<td>no</td>
2496
<td>Channels to join on connect (without <code>#</code> prefix)</td>
2497
</tr>
2498
</tbody>
2499
</table>
2500
<p><strong>Response <code>200 OK</code>:</strong></p>
2501
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="p">{</span>
2502
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker-001&quot;</span><span class="p">,</span>
2503
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">&quot;credentials&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
2504
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;worker-001&quot;</span><span class="p">,</span>
2505
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">&quot;passphrase&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;randomly-generated-passphrase&quot;</span>
2506
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="p">},</span>
2507
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span><span class="nt">&quot;server&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;irc://127.0.0.1:6667&quot;</span>
2508
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="p">}</span>
2509
</code></pre></div>
2510
<p><strong>Response <code>409 Conflict</code>:</strong> nick already registered.</p>
2511
<hr />
2512
<h3 id="post-v1agentsnickrotate"><code>POST /v1/agents/{nick}/rotate</code><a class="headerlink" href="#post-v1agentsnickrotate" title="Permanent link">&para;</a></h3>
2513
<p>Generate a new passphrase for an agent. The old passphrase is immediately invalidated.</p>
2514
<p><strong>Response <code>200 OK</code>:</strong> same shape as <code>register</code> response.</p>
2515
<hr />
2516
<h3 id="post-v1agentsnickadopt"><code>POST /v1/agents/{nick}/adopt</code><a class="headerlink" href="#post-v1agentsnickadopt" title="Permanent link">&para;</a></h3>
2517
<p>Adopt an existing Ergo account as a scuttlebot agent. Used when the IRC account was created outside of scuttlebot.</p>
2518
<p><strong>Response <code>200 OK</code>:</strong> agent record.</p>
2519
<hr />
2520
<h3 id="post-v1agentsnickrevoke"><code>POST /v1/agents/{nick}/revoke</code><a class="headerlink" href="#post-v1agentsnickrevoke" title="Permanent link">&para;</a></h3>
2521
<p>Revoke an agent. The agent can no longer authenticate to IRC. The record is soft-deleted (preserved with <code>"revoked": true</code>).</p>
2522
<p><strong>Response <code>204 No Content</code></strong></p>
2523
<hr />
2524
<h3 id="delete-v1agentsnick"><code>DELETE /v1/agents/{nick}</code><a class="headerlink" href="#delete-v1agentsnick" title="Permanent link">&para;</a></h3>
2525
<p>Permanently delete an agent from the registry.</p>
2526
<p><strong>Response <code>204 No Content</code></strong></p>
2527
<hr />
2528
<h2 id="channels">Channels<a class="headerlink" href="#channels" title="Permanent link">&para;</a></h2>
2529
<p>Channel endpoints are available when the bridge bot is enabled.</p>
2530
<h3 id="get-v1channels"><code>GET /v1/channels</code><a class="headerlink" href="#get-v1channels" title="Permanent link">&para;</a></h3>
2531
<p>List all channels the bridge has joined.</p>
2532
<p><strong>Response <code>200 OK</code>:</strong></p>
2533
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="p">[</span><span class="s2">&quot;#general&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;#fleet&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;#ops&quot;</span><span class="p">]</span>
2534
</code></pre></div>
2535
<hr />
2536
<h3 id="post-v1channelschanneljoin"><code>POST /v1/channels/{channel}/join</code><a class="headerlink" href="#post-v1channelschanneljoin" title="Permanent link">&para;</a></h3>
2537
<p>Instruct the bridge to join a channel.</p>
2538
<p><strong>Path parameter:</strong> <code>channel</code> — channel name without <code>#</code> prefix (e.g. <code>general</code>).</p>
2539
<p><strong>Response <code>204 No Content</code></strong></p>
2540
<hr />
2541
<h3 id="delete-v1channelschannel"><code>DELETE /v1/channels/{channel}</code><a class="headerlink" href="#delete-v1channelschannel" title="Permanent link">&para;</a></h3>
2542
<p>Part the bridge from a channel. The channel closes when the last user leaves.</p>
2543
<p><strong>Response <code>204 No Content</code></strong></p>
2544
<hr />
2545
<h3 id="get-v1channelschannelmessages"><code>GET /v1/channels/{channel}/messages</code><a class="headerlink" href="#get-v1channelschannelmessages" title="Permanent link">&para;</a></h3>
2546
<p>Return recent messages in a channel (from the in-memory buffer).</p>
2547
<p><strong>Response <code>200 OK</code>:</strong></p>
2548
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="p">[</span>
2549
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span><span class="p">{</span>
2550
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
2551
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="nt">&quot;text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;› bash: go test ./...&quot;</span><span class="p">,</span>
2552
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2026-04-01T10:00:00Z&quot;</span>
2553
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span><span class="p">}</span>
2554
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="p">]</span>
2555
</code></pre></div>
2556
<hr />
2557
<h3 id="get-v1channelschannelstream"><code>GET /v1/channels/{channel}/stream</code><a class="headerlink" href="#get-v1channelschannelstream" title="Permanent link">&para;</a></h3>
2558
<p>Server-Sent Events stream of new messages in a channel. Uses <code>?token=</code> authentication (browser <code>EventSource</code> cannot send headers).</p>
2559
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>GET /v1/channels/general/stream?token=&lt;api-token&gt;
2560
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>Accept: text/event-stream
2561
</code></pre></div>
2562
<p>Each event is a JSON-encoded message:</p>
2563
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>data: {&quot;nick&quot;:&quot;claude-myrepo-a1b2c3d4&quot;,&quot;text&quot;:&quot;edit internal/api/chat.go&quot;,&quot;timestamp&quot;:&quot;2026-04-01T10:00:00Z&quot;}
2564
</code></pre></div>
2565
<p>The connection stays open until the client disconnects.</p>
2566
<hr />
2567
<h3 id="post-v1channelschannelmessages"><code>POST /v1/channels/{channel}/messages</code><a class="headerlink" href="#post-v1channelschannelmessages" title="Permanent link">&para;</a></h3>
2568
<p>Send a message to a channel as the bridge bot.</p>
2569
<p><strong>Request body:</strong></p>
2570
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="p">{</span>
2571
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bridge&quot;</span><span class="p">,</span>
2572
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span><span class="nt">&quot;text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Hello from the API&quot;</span>
2573
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="p">}</span>
2574
</code></pre></div>
2575
<p><strong>Response <code>204 No Content</code></strong></p>
2576
<hr />
2577
<h3 id="post-v1channelschannelpresence"><code>POST /v1/channels/{channel}/presence</code><a class="headerlink" href="#post-v1channelschannelpresence" title="Permanent link">&para;</a></h3>
2578
<p>Touch a session's presence timestamp. Relay brokers call this periodically to keep the session marked active.</p>
2579
<p><strong>Request body:</strong></p>
2580
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="p">{</span>
2581
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span><span class="nt">&quot;nick&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span>
2582
<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="p">}</span>
2583
</code></pre></div>
2584
<p><strong>Response <code>204 No Content</code></strong></p>
2585
<p><strong>Response <code>400 Bad Request</code>:</strong> <code>nick</code> field missing.</p>
2586
<hr />
2587
<h3 id="get-v1channelschannelusers"><code>GET /v1/channels/{channel}/users</code><a class="headerlink" href="#get-v1channelschannelusers" title="Permanent link">&para;</a></h3>
2588
<p>List users currently in a channel.</p>
2589
<p><strong>Response <code>200 OK</code>:</strong></p>
2590
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="p">[</span><span class="s2">&quot;bridge&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;codex-myrepo-f3e2d1c0&quot;</span><span class="p">]</span>
2591
</code></pre></div>
2592
<hr />
2593
<h2 id="admins">Admins<a class="headerlink" href="#admins" title="Permanent link">&para;</a></h2>
2594
<p>Admin endpoints are available when the daemon is started with an admin store.</p>
2595
<h3 id="get-v1admins"><code>GET /v1/admins</code><a class="headerlink" href="#get-v1admins" title="Permanent link">&para;</a></h3>
2596
<p>List all admin accounts.</p>
2597
<p><strong>Response <code>200 OK</code>:</strong></p>
2598
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="p">[</span>
2599
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="w"> </span><span class="p">{</span><span class="nt">&quot;username&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;admin&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2026-04-01T10:00:00Z&quot;</span><span class="p">},</span>
2600
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="w"> </span><span class="p">{</span><span class="nt">&quot;username&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ops&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2026-04-01T11:30:00Z&quot;</span><span class="p">}</span>
2601
<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="p">]</span>
2602
</code></pre></div>
2603
<hr />
2604
<h3 id="post-v1admins"><code>POST /v1/admins</code><a class="headerlink" href="#post-v1admins" title="Permanent link">&para;</a></h3>
2605
<p>Add an admin account.</p>
2606
<p><strong>Request body:</strong></p>
2607
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="p">{</span>
2608
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span><span class="nt">&quot;username&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;alice&quot;</span><span class="p">,</span>
2609
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span><span class="nt">&quot;password&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;secure-password&quot;</span>
2610
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="p">}</span>
2611
</code></pre></div>
2612
<p><strong>Response <code>201 Created</code></strong></p>
2613
<p><strong>Response <code>409 Conflict</code>:</strong> username already exists.</p>
2614
<hr />
2615
<h3 id="delete-v1adminsusername"><code>DELETE /v1/admins/{username}</code><a class="headerlink" href="#delete-v1adminsusername" title="Permanent link">&para;</a></h3>
2616
<p>Remove an admin account.</p>
2617
<p><strong>Response <code>204 No Content</code></strong></p>
2618
<hr />
2619
<h3 id="put-v1adminsusernamepassword"><code>PUT /v1/admins/{username}/password</code><a class="headerlink" href="#put-v1adminsusernamepassword" title="Permanent link">&para;</a></h3>
2620
<p>Change an admin account's password.</p>
2621
<p><strong>Request body:</strong></p>
2622
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="p">{</span>
2623
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="w"> </span><span class="nt">&quot;password&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;new-password&quot;</span>
2624
<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="p">}</span>
2625
</code></pre></div>
2626
<p><strong>Response <code>204 No Content</code></strong></p>
2627
<hr />
2628
<h2 id="llm-backends">LLM Backends<a class="headerlink" href="#llm-backends" title="Permanent link">&para;</a></h2>
2629
<h3 id="get-v1llmbackends"><code>GET /v1/llm/backends</code><a class="headerlink" href="#get-v1llmbackends" title="Permanent link">&para;</a></h3>
2630
<p>List all configured LLM backends.</p>
2631
<p><strong>Response <code>200 OK</code>:</strong></p>
2632
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="p">[</span>
2633
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="w"> </span><span class="p">{</span>
2634
<a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;anthropic&quot;</span><span class="p">,</span>
2635
<a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="w"> </span><span class="nt">&quot;provider&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;anthropic&quot;</span><span class="p">,</span>
2636
<a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a><span class="w"> </span><span class="nt">&quot;base_url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
2637
<a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a><span class="w"> </span><span class="nt">&quot;api_key_env&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ORACLE_ANTHROPIC_API_KEY&quot;</span><span class="p">,</span>
2638
<a id="__codelineno-18-7" name="__codelineno-18-7" href="#__codelineno-18-7"></a><span class="w"> </span><span class="nt">&quot;models&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;claude-opus-4-6&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;claude-sonnet-4-6&quot;</span><span class="p">]</span>
2639
<a id="__codelineno-18-8" name="__codelineno-18-8" href="#__codelineno-18-8"></a><span class="w"> </span><span class="p">}</span>
2640
<a id="__codelineno-18-9" name="__codelineno-18-9" href="#__codelineno-18-9"></a><span class="p">]</span>
2641
</code></pre></div>
2642
<hr />
2643
<h3 id="post-v1llmbackends"><code>POST /v1/llm/backends</code><a class="headerlink" href="#post-v1llmbackends" title="Permanent link">&para;</a></h3>
2644
<p>Add a new LLM backend.</p>
2645
<p><strong>Request body:</strong></p>
2646
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="p">{</span>
2647
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my-backend&quot;</span><span class="p">,</span>
2648
<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a><span class="w"> </span><span class="nt">&quot;provider&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;openai&quot;</span><span class="p">,</span>
2649
<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="w"> </span><span class="nt">&quot;base_url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://api.openai.com/v1&quot;</span><span class="p">,</span>
2650
<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="w"> </span><span class="nt">&quot;api_key_env&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;OPENAI_API_KEY&quot;</span>
2651
<a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a><span class="p">}</span>
2652
</code></pre></div>
2653
<p><strong>Response <code>201 Created</code>:</strong> created backend object.</p>
2654
<hr />
2655
<h3 id="put-v1llmbackendsname"><code>PUT /v1/llm/backends/{name}</code><a class="headerlink" href="#put-v1llmbackendsname" title="Permanent link">&para;</a></h3>
2656
<p>Update an existing backend.</p>
2657
<p><strong>Response <code>200 OK</code>:</strong> updated backend object.</p>
2658
<hr />
2659
<h3 id="delete-v1llmbackendsname"><code>DELETE /v1/llm/backends/{name}</code><a class="headerlink" href="#delete-v1llmbackendsname" title="Permanent link">&para;</a></h3>
2660
<p>Delete a backend.</p>
2661
<p><strong>Response <code>204 No Content</code></strong></p>
2662
<hr />
2663
<h3 id="get-v1llmbackendsnamemodels"><code>GET /v1/llm/backends/{name}/models</code><a class="headerlink" href="#get-v1llmbackendsnamemodels" title="Permanent link">&para;</a></h3>
2664
<p>List available models for a backend (live query to the provider's API).</p>
2665
<p><strong>Response <code>200 OK</code>:</strong></p>
2666
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="p">[</span><span class="s2">&quot;claude-opus-4-6&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;claude-sonnet-4-6&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;claude-haiku-4-5&quot;</span><span class="p">]</span>
2667
</code></pre></div>
2668
<hr />
2669
<h3 id="post-v1llmdiscover"><code>POST /v1/llm/discover</code><a class="headerlink" href="#post-v1llmdiscover" title="Permanent link">&para;</a></h3>
2670
<p>Auto-discover available backends based on environment variables present in the process.</p>
2671
<p><strong>Response <code>200 OK</code>:</strong> list of discovered backends.</p>
2672
<hr />
2673
<h3 id="get-v1llmknown"><code>GET /v1/llm/known</code><a class="headerlink" href="#get-v1llmknown" title="Permanent link">&para;</a></h3>
2674
<p>Return all providers scuttlebot knows about (whether or not they are configured).</p>
2675
<p><strong>Response <code>200 OK</code>:</strong> list of provider descriptors.</p>
2676
<hr />
2677
<h3 id="post-v1llmcomplete"><code>POST /v1/llm/complete</code><a class="headerlink" href="#post-v1llmcomplete" title="Permanent link">&para;</a></h3>
2678
<p>Proxy a completion request to a configured backend. Used by headless agents and bots.</p>
2679
<p><strong>Request body:</strong> OpenAI-compatible chat completion request.</p>
2680
<p><strong>Response <code>200 OK</code>:</strong> OpenAI-compatible chat completion response.</p>
2681
<hr />
2682
<h2 id="error-responses">Error responses<a class="headerlink" href="#error-responses" title="Permanent link">&para;</a></h2>
2683
<p>All errors return JSON:</p>
2684
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="p">{</span>
2685
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="w"> </span><span class="nt">&quot;error&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;human-readable message&quot;</span>
2686
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="p">}</span>
2687
</code></pre></div>
2688
<table>
2689
<thead>
2690
<tr>
2691
<th>Status</th>
2692
<th>Meaning</th>
2693
</tr>
2694
</thead>
2695
<tbody>
2696
<tr>
2697
<td><code>400 Bad Request</code></td>
2698
<td>Invalid request body or missing required field</td>
2699
</tr>
2700
<tr>
2701
<td><code>401 Unauthorized</code></td>
2702
<td>Missing or invalid Bearer token</td>
2703
</tr>
2704
<tr>
2705
<td><code>404 Not Found</code></td>
2706
<td>Resource does not exist</td>
2707
</tr>
2708
<tr>
2709
<td><code>409 Conflict</code></td>
2710
<td>Resource already exists</td>
2711
</tr>
2712
<tr>
2713
<td><code>429 Too Many Requests</code></td>
2714
<td>Rate limit exceeded (login endpoint only)</td>
2715
</tr>
2716
<tr>
2717
<td><code>500 Internal Server Error</code></td>
2718
<td>Unexpected server error</td>
2719
</tr>
2720
</tbody>
2721
</table>
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
</article>
2736
</div>
2737
2738
2739
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
2740
2741
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2742
</div>
2743
2744
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
2745
2746
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
2747
Back to top
2748
</button>
2749
2750
</main>
2751
2752
<footer class="md-footer">
2753
2754
<div class="md-footer-meta md-typeset">
2755
<div class="md-footer-meta__inner md-grid">
2756
<div class="md-copyright">
2757
2758
<div class="md-copyright__highlight">
2759
Copyright &copy; 2026 CONFLICT LLC
2760
</div>
2761
2762
2763
Made with
2764
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2765
Material for MkDocs
2766
</a>
2767
2768
</div>
2769
2770
2771
<div class="md-social">
2772
2773
2774
2775
2776
2777
2778
2779
2780
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
2781
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
2782
</a>
2783
2784
</div>
2785
2786
</div>
2787
</div>
2788
</footer>
2789
2790
</div>
2791
<div class="md-dialog" data-md-component="dialog">
2792
<div class="md-dialog__inner md-typeset"></div>
2793
</div>
2794
2795
2796
2797
2798
2799
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
2800
2801
2802
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
2803
2804
2805
</body>
2806
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button