-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathopenapi.yaml
More file actions
4737 lines (4643 loc) · 135 KB
/
openapi.yaml
File metadata and controls
4737 lines (4643 loc) · 135 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
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Eliza OS API
description: |-
API documentation for Eliza OS v1.2.0 - A flexible and scalable AI agent framework.
This API is designed to be used with a locally running Eliza instance. Endpoints allow for creating,
managing, and interacting with AI agents through a REST interface.
The API is organized into the following domains:
- **System**: System-wide operations and environment management
- **Agents**: Agent lifecycle and management operations
- **Memory**: Agent memory and room management
- **Messaging**: Message handling, channels, and servers
- **Audio**: Audio processing and speech synthesis
- **Media**: File upload and media management
- **TEE**: Trusted Execution Environment operations
- **WebSocket**: Real-time communication via Socket.IO
version: 1.2.0
contact:
name: Eliza OS Community
url: https://github.com/elizaos/eliza
servers:
- url: http://localhost:3000
description: Local development server
tags:
- name: system
description: System-wide operations and environment management
- name: agents
description: Operations for managing AI agents
- name: memory
description: Operations for managing agent memories
- name: rooms
description: Operations for managing rooms
- name: messaging
description: Operations for messages, channels, and servers
- name: audio
description: Operations for speech and audio processing
- name: media
description: Operations for file uploads and media management
- name: logs
description: Operations for accessing system and agent logs
- name: tee
description: Trusted Execution Environment operations
- name: websocket
description: Real-time WebSocket communication
paths:
# System endpoints
/api/server/ping:
get:
tags:
- system
summary: Ping health check
description: Simple ping endpoint to check if server is responsive
operationId: getPing
responses:
"200":
description: Server is responsive
content:
application/json:
schema:
type: object
properties:
pong:
type: boolean
example: true
timestamp:
type: integer
description: Current timestamp in milliseconds
/api/server/hello:
get:
tags:
- system
summary: Basic health check
description: Simple hello world test endpoint
operationId: getHello
responses:
"200":
description: Hello world response
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Hello World!"
/api/server/status:
get:
tags:
- system
summary: Get system status
description: Returns the current status of the system with agent count and timestamp
operationId: getStatus
responses:
"200":
description: System status information
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "ok"
agentCount:
type: integer
description: Number of active agents
timestamp:
type: string
format: date-time
description: Current timestamp
/api/server/health:
get:
tags:
- system
summary: Health check endpoint
description: Detailed health check for the system
operationId: getHealth
responses:
"200":
description: System is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "OK"
version:
type: string
timestamp:
type: string
format: date-time
dependencies:
type: object
properties:
agents:
type: string
example: "healthy"
"503":
description: System is unhealthy
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/server/logs:
get:
tags:
- logs
summary: Get system logs
description: Retrieve system logs with optional filtering
operationId: getLogs
parameters:
- name: since
in: query
schema:
type: integer
description: Timestamp (ms) to get logs from
- name: level
in: query
schema:
type: string
enum: [all, trace, debug, info, warn, error, fatal]
default: info
- name: agentName
in: query
schema:
type: string
- name: agentId
in: query
schema:
type: string
format: uuid
- name: limit
in: query
schema:
type: integer
default: 100
maximum: 1000
responses:
"200":
description: System logs
content:
application/json:
schema:
type: object
properties:
logs:
type: array
items:
$ref: "#/components/schemas/LogEntry"
count:
type: integer
total:
type: integer
level:
type: string
levels:
type: array
items:
type: string
"500":
description: Error retrieving logs
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
tags:
- logs
summary: Get system logs (POST)
description: Retrieve system logs with optional filtering using POST method
operationId: postLogs
requestBody:
content:
application/json:
schema:
type: object
properties:
since:
type: integer
description: Timestamp (ms) to get logs from
level:
type: string
enum: [all, trace, debug, info, warn, error, fatal]
default: info
agentName:
type: string
agentId:
type: string
format: uuid
limit:
type: integer
default: 100
maximum: 1000
responses:
"200":
description: System logs
content:
application/json:
schema:
type: object
properties:
logs:
type: array
items:
$ref: "#/components/schemas/LogEntry"
count:
type: integer
total:
type: integer
level:
type: string
levels:
type: array
items:
type: string
"500":
description: Error retrieving logs
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
tags:
- logs
summary: Clear system logs
description: Clear all system logs
operationId: clearLogs
responses:
"200":
description: Logs cleared successfully
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "success"
message:
type: string
example: "Logs cleared successfully"
"500":
description: Error clearing logs
content:
application/json:
schema:
type: object
properties:
error:
type: string
message:
type: string
/api/server/stop:
post:
tags:
- system
summary: Stop the server
description: Initiates server shutdown
operationId: stopServer
responses:
"200":
description: Server is shutting down
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Server stopping..."
/api/server/debug/servers:
get:
tags:
- system
summary: Get server debug info
description: Get debug information about active servers (debug endpoint)
operationId: getDebugServers
responses:
"200":
description: Server debug information
content:
application/json:
schema:
type: object
properties:
servers:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
status:
type: string
agents:
type: array
items:
type: string
format: uuid
/api/server/servers:
get:
tags:
- system
summary: Get server debug info
description: Get debug information about active servers (debug endpoint)
operationId: getServers
responses:
"200":
description: Server debug information
content:
application/json:
schema:
type: object
properties:
servers:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
status:
type: string
agents:
type: array
items:
type: string
/api/system/environment/local:
get:
tags:
- system
summary: Get local environment variables
description: Retrieve local environment variables from .env file
operationId: getLocalEnv
responses:
"200":
description: Local environment variables
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
additionalProperties:
type: string
"500":
description: Error retrieving environment variables
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
tags:
- system
summary: Update local environment variables
description: Update local environment variables in .env file
operationId: updateLocalEnv
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
content:
type: object
additionalProperties:
type: string
description: Key-value pairs of environment variables
responses:
"200":
description: Environment variables updated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: "Local env updated"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error updating environment variables
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
# Agent endpoints
/api/agents:
get:
tags:
- agents
summary: List all agents
description: Returns a list of all available agents
operationId: listAgents
responses:
"200":
description: List of agents
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
agents:
type: array
items:
$ref: "#/components/schemas/AgentInfo"
"500":
description: Error retrieving agents
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
tags:
- agents
summary: Create a new agent
description: Creates a new agent from character configuration
operationId: createAgent
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
characterPath:
type: string
description: Path to a character file
characterJson:
type: object
description: Character configuration in JSON format
responses:
"201":
description: Agent created successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
character:
$ref: "#/components/schemas/Character"
"400":
description: Error creating agent
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}:
get:
tags:
- agents
summary: Get agent details
description: Returns detailed information about a specific agent
operationId: getAgent
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent to retrieve
responses:
"200":
description: Agent details
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: "#/components/schemas/AgentInfo"
"400":
description: Invalid agent ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
patch:
tags:
- agents
summary: Update agent
description: Update an existing agent
operationId: updateAgent
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent to update
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Agent updates
responses:
"200":
description: Agent updated successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: "#/components/schemas/AgentInfo"
"400":
description: Invalid agent ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error updating agent
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
tags:
- agents
summary: Delete an agent
description: Permanently deletes an agent
operationId: deleteAgent
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent to delete
responses:
"200":
description: Agent deleted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
"202":
description: Agent deletion initiated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
partial:
type: boolean
example: true
message:
type: string
"400":
description: Invalid agent ID format
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"408":
description: Agent deletion operation timed out
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"409":
description: Cannot delete agent due to active references
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error deleting agent
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}/start:
post:
tags:
- agents
summary: Start an agent
description: Starts an existing agent
operationId: startAgent
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent to start
responses:
"200":
description: Agent started successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
status:
type: string
enum: [active]
"400":
description: Invalid agent ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error starting agent
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}/stop:
post:
tags:
- agents
summary: Stop an agent
description: Stops a running agent
operationId: stopAgent
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent to stop
responses:
"200":
description: Agent stopped successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
message:
type: string
"400":
description: Invalid agent ID format
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}/logs:
get:
tags:
- logs
summary: Get agent logs
description: Retrieve logs for a specific agent
operationId: getAgentLogs
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent
- name: since
in: query
schema:
type: integer
description: Timestamp (ms) to get logs from
- name: until
in: query
schema:
type: integer
description: Timestamp (ms) to get logs until
- name: level
in: query
schema:
type: string
enum: [trace, debug, info, warn, error, fatal]
default: info
- name: limit
in: query
schema:
type: integer
default: 100
maximum: 1000
responses:
"200":
description: Agent logs retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
logs:
type: array
items:
$ref: "#/components/schemas/LogEntry"
count:
type: integer
"400":
description: Invalid agent ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error retrieving logs
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}/logs/{logId}:
delete:
tags:
- logs
summary: Delete a specific log entry
description: Delete a specific log entry for an agent
operationId: deleteAgentLog
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent
- name: logId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the log entry to delete
responses:
"204":
description: Log entry deleted successfully
"400":
description: Invalid agent ID or log ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent or log not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error deleting log
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/{agentId}/panels:
get:
tags:
- agents
summary: Get agent panels
description: Get public UI panels available for this agent from its plugins
operationId: getAgentPanels
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: ID of the agent
responses:
"200":
description: Agent panels retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: array
items:
type: object
properties:
name:
type: string
description: Display name of the panel
path:
type: string
description: URL path to access the panel
"400":
description: Invalid agent ID
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Agent not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Error retrieving panels
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/agents/worlds:
get:
tags:
- agents
summary: Get all worlds
description: Get all worlds across all agents
operationId: getAllWorlds
responses:
"200":
description: Worlds retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties: