forked from omnigent-ai/omnigent
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
10508 lines (10508 loc) · 388 KB
/
Copy pathopenapi.json
File metadata and controls
10508 lines (10508 loc) · 388 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
{
"components": {
"schemas": {
"AddCommentRequest": {
"description": "Request body for `POST /sessions/{id}/comments`.",
"properties": {
"anchor_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Plain-text snapshot of the selected range, used to re-anchor the comment after file edits. `None` if not provided.",
"title": "Anchor Content"
},
"body": {
"description": "The comment text.",
"title": "Body",
"type": "string"
},
"end_index": {
"description": "0-based absolute character offset (exclusive) within the file where the anchor range ends.",
"title": "End Index",
"type": "integer"
},
"path": {
"description": "File path relative to workspace root, e.g. `\"src/App.tsx\"`.",
"title": "Path",
"type": "string"
},
"start_index": {
"description": "0-based absolute character offset (inclusive) within the file where the anchor range begins.",
"title": "Start Index",
"type": "integer"
}
},
"required": [
"path",
"body",
"start_index",
"end_index"
],
"title": "AddCommentRequest",
"type": "object"
},
"AgentObject": {
"description": "API representation of a registered agent.",
"properties": {
"builtin": {
"default": false,
"description": "Whether this is a server-*seeded* built-in agent (deterministic, name-derived id) as opposed to an operator/user-registered template (random id, e.g. via `omnigent server --agent`) or a session-scoped upload. The Web UI's new-session picker uses this to decide whether a same-named `omnigent run` upload may shadow the catalog entry: seeded built-ins are protected, while a user-registered template is superseded by a newer same-named upload. Always `False` for session-scoped agents.",
"title": "Builtin",
"type": "boolean"
},
"created_at": {
"description": "Unix epoch timestamp of creation.",
"title": "Created At",
"type": "integer"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional free-text description of the agent's purpose.",
"title": "Description"
},
"harness": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The agent's harness/kind, e.g. `\"codex\"`, `\"codex-native\"`, or `\"claude-native\"` for `executor.type: omnigent` agents, otherwise the executor type (`\"claude_sdk\"`, `\"agents_sdk\"`). `None` when the bundle cannot be loaded. Lets the Web UI Add Agent picker recognise an agent's kind (Codex vs Claude) without hardcoding by name slug.",
"title": "Harness"
},
"id": {
"description": "Unique agent identifier, e.g. `\"ag_abc123\"`.",
"title": "Id",
"type": "string"
},
"mcp_servers": {
"description": "MCP servers the agent is connected to (secret fields omitted). Empty list when the spec declares no MCP servers or when the bundle cannot be loaded.",
"items": {
"$ref": "#/components/schemas/MCPServerSummary"
},
"title": "Mcp Servers",
"type": "array"
},
"mcp_servers_editable": {
"default": false,
"description": "Whether the MCP list can be edited through the session UI. Built-in template agents are read-only; session-scoped uploaded agents are editable.",
"title": "Mcp Servers Editable",
"type": "boolean"
},
"name": {
"description": "Human-readable agent name, e.g. `\"research-agent\"`.",
"title": "Name",
"type": "string"
},
"object": {
"default": "agent",
"description": "Fixed resource type, always `\"agent\"`.",
"title": "Object",
"type": "string"
},
"policies": {
"description": "Guardrails policies declared on the agent. Each entry summarises the policy name, type, and phases. Empty list when the spec declares no policies or when the bundle cannot be loaded.",
"items": {
"$ref": "#/components/schemas/PolicySummary"
},
"title": "Policies",
"type": "array"
},
"skills": {
"description": "Skills bundled in the agent spec (`skills/<name>/SKILL.md`). Lets the Web UI's new-session composer offer a slash-command menu before a session (and its runner) exists. Host-discovered skills are runner-owned, so they are NOT listed here \u2014 the session snapshot's `skills` field carries the merged set once a runner is bound. Empty list when the spec bundles no skills or when the bundle cannot be loaded.",
"items": {
"$ref": "#/components/schemas/SkillSummary"
},
"title": "Skills",
"type": "array"
},
"terminals": {
"description": "Terminal names declared in the spec's `terminals:` block, in declaration order, e.g. `[\"shell\"]`. The Web UI gates its \"new terminal\" affordance on this list (creation is only offered for agents with terminal access) and offers these names as the launchable choices. Empty list when the spec declares no terminals or when the bundle cannot be loaded.",
"items": {
"type": "string"
},
"title": "Terminals",
"type": "array"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unix epoch timestamp of the last update, or `None` if never updated.",
"title": "Updated At"
},
"version": {
"default": 1,
"description": "Monotonic version counter. Starts at 1, incremented on each update.",
"title": "Version",
"type": "integer"
}
},
"required": [
"id",
"name",
"created_at"
],
"title": "AgentObject",
"type": "object"
},
"Body_update_session_agent_v1_sessions__session_id__agent_put": {
"properties": {
"bundle": {
"contentMediaType": "application/octet-stream",
"title": "Bundle",
"type": "string"
}
},
"required": [
"bundle"
],
"title": "Body_update_session_agent_v1_sessions__session_id__agent_put",
"type": "object"
},
"Body_upload_session_file_v1_sessions__session_id__resources_files_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_upload_session_file_v1_sessions__session_id__resources_files_post",
"type": "object"
},
"CancelledEvent": {
"description": "Terminal event for a turn cancelled before completion.",
"properties": {
"response": {
"$ref": "#/components/schemas/ResponseObject",
"description": "The final response object with `status=\"cancelled\"`."
},
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"type": {
"const": "response.cancelled",
"description": "Always `\"response.cancelled\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"response"
],
"title": "CancelledEvent",
"type": "object"
},
"ChildSessionList": {
"description": "Paginated list of child sessions; `data` is a page of `ChildSessionSummary`.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ChildSessionSummary"
},
"title": "Data",
"type": "array"
},
"first_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Id"
},
"has_more": {
"default": false,
"title": "Has More",
"type": "boolean"
},
"last_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Id"
},
"object": {
"const": "list",
"default": "list",
"title": "Object",
"type": "string"
}
},
"title": "ChildSessionList",
"type": "object"
},
"ChildSessionSummary": {
"description": "Summary of a sub-agent (child) session under a parent session.\n\nPowers `GET /v1/sessions/{id}/child_sessions`. Lets the web /\nREPL debug surface enumerate sub-agent calls spawned from a\nparent session without parsing parent `function_call_output`\nJSON handles (the legacy TUI Ctrl+O path). The endpoint is the\ncanonical \"historical truth\" source; the existing transient\n`session.created` SSE event handles live incremental updates.\n\nFields are derived from the child `Conversation` plus its\nlatest `Task` (newest by `created_at`).",
"properties": {
"agent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Agent id recorded on the latest task, e.g. `\"ag_abc123\"`. `None` if the child has no tasks yet (rare \u2014 `_spawn_one` creates a task atomically with the conversation).",
"title": "Agent Id"
},
"agent_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Agent type recorded on the latest task, e.g. `\"researcher\"`. Mirrors the `tool` prefix in `title` and is provided alongside it because the title is a denormalized string while `agent_name` is the durable per-task value.",
"title": "Agent Name"
},
"busy": {
"default": false,
"description": "`True` when the child's session loop is live. Mirrors the algorithm used by `GET /v1/sessions/{id}` to compute `status`: read the live in-memory cache first (`\"running\"`/`\"waiting\"` \u2192 busy), and fall back to the latest task's status on cache miss (`\"queued\"` / `\"in_progress\"` \u2192 busy). For NO_DBOS sessions the tasks table is not populated during active runs, so the cache consult is what keeps the rail's \"Working\" badge correct.",
"title": "Busy",
"type": "boolean"
},
"created_at": {
"description": "Unix epoch timestamp of child creation.",
"title": "Created At",
"type": "integer"
},
"current_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest task id for the child (newest by `created_at`), e.g. `\"task_abc123\"`. `None` if no tasks exist.",
"title": "Current Task Id"
},
"current_task_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Status of the latest task, e.g. `\"completed\"`, `\"in_progress\"`, `\"failed\"`. `None` if no tasks exist.",
"title": "Current Task Status"
},
"id": {
"description": "Child conversation/session identifier, e.g. `\"conv_child123\"`.",
"title": "Id",
"type": "string"
},
"kind": {
"default": "sub_agent",
"description": "Conversation kind discriminator, always `\"sub_agent\"` for rows surfaced by this endpoint.",
"title": "Kind",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Session-scoped guardrails labels on the child conversation (mirrors `ConversationObject.labels`).",
"title": "Labels",
"type": "object"
},
"last_message_preview": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Single-line preview of the most recent message item in the child's conversation, truncated to ~150 chars with a trailing ellipsis when longer. `None` when the child has no message items yet (rare \u2014 the spawn tool immediately commits a user message). Lets the UI render a real-time \"what's the sub-agent saying right now\" line without fetching the child's full item history.",
"title": "Last Message Preview"
},
"last_task_error": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Error details from the child's most recent failed run, e.g. `{\"code\": \"required_terminal_exited\", \"message\": \"...\"}`. `None` when the child has no durable failure detail. This is the typed projection of runner-owned failure labels; clients should not parse those labels directly.",
"title": "Last Task Error"
},
"object": {
"default": "child_session",
"description": "Fixed resource type, always `\"child_session\"`.",
"title": "Object",
"type": "string"
},
"parent_session_id": {
"description": "Parent conversation id (echo of the route's `session_id` path parameter), e.g. `\"conv_parent987\"`. Stable join key for clients that cache child rows across multiple parents.",
"title": "Parent Session Id",
"type": "string"
},
"pending_elicitations_count": {
"default": 0,
"description": "Number of approval / input prompts the child is currently blocked on, read from the server's `omnigent.runtime.pending_elicitations` index. `> 0` means the sub-agent is parked awaiting user input \u2014 the Agents rail renders an \"awaiting input\" badge so a fanned-out sub-agent that needs attention is visible without opening its chat. Mirrors `SessionListItem.pending_elicitations_count`.",
"title": "Pending Elicitations Count",
"type": "integer"
},
"session_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Sub-agent instance name, the suffix of `title` after the first `\":\"`, e.g. `\"auth\"`. `None` if `title` is `None` or missing a colon.",
"title": "Session Name"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Sub-agent title, `\"{agent_type}:{session_name}\"` as written by `omnigent.tools.builtins.spawn._spawn_one`, e.g. `\"researcher:auth\"`. `None` only for legacy / malformed rows; the spawn path always sets it.",
"title": "Title"
},
"tool": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "UI-facing sub-agent label. For Omnigent-spawned children this is derived from the prefix of `title` before the first `\":\"`, e.g. `\"researcher\"`. For Codex-native children this is the Codex-assigned `agent_nickname` when available, then `agent_role`, then `\"Codex\"`. Falls back to the raw title for legacy / malformed rows; `None` only when `title` itself is `None` or empty.",
"title": "Tool"
},
"updated_at": {
"description": "Unix epoch timestamp of the child's most recent update.",
"title": "Updated At",
"type": "integer"
}
},
"required": [
"id",
"parent_session_id",
"created_at",
"updated_at"
],
"title": "ChildSessionSummary",
"type": "object"
},
"ClearCodexGoalResponse": {
"description": "Response body for `DELETE /v1/sessions/{id}/codex_goal`.",
"properties": {
"cleared": {
"description": "`True` when Codex removed an existing goal; `False` when no goal was present.",
"title": "Cleared",
"type": "boolean"
}
},
"required": [
"cleared"
],
"title": "ClearCodexGoalResponse",
"type": "object"
},
"ClientTaskCancelEvent": {
"description": "Server-side request that the client cancel a tunneled tool call.\n\nEmitted by `omnigent/runtime/workflow.py` when a parent\ncancellation needs to propagate to a long-running async client\ntool. Wire shape matches `workflow.py:4258-4266`.",
"properties": {
"call_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Synthetic `call_id` the SDK uses to reconcile the local task; `None` when no pending tool call row exists for the task.",
"title": "Call Id"
},
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"task_id": {
"description": "Identifier of the client-side task being cancelled, e.g. `\"resp_async_abc\"`.",
"title": "Task Id",
"type": "string"
},
"type": {
"const": "response.client_task.cancel",
"description": "Always `\"response.client_task.cancel\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"task_id"
],
"title": "ClientTaskCancelEvent",
"type": "object"
},
"CodexGoalObject": {
"description": "Current Codex goal state for a Codex-native session.\n\nMirrors Codex app-server's `ThreadGoal` shape using Omnigent's\nsnake-case API convention. `created_at` and `updated_at` are optional\nbecause older app-server documentation examples omit them even though the\ncurrent protocol includes them.",
"properties": {
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unix timestamp when the goal was created, e.g. `1776272400`. `None` when not provided by Codex.",
"title": "Created At"
},
"objective": {
"description": "Goal objective text, e.g. `\"Finish the migration and keep tests green\"`.",
"title": "Objective",
"type": "string"
},
"status": {
"description": "Raw Codex goal lifecycle status, e.g. `\"active\"`.",
"title": "Status",
"type": "string"
},
"thread_id": {
"description": "Codex app-server thread id, e.g. `\"thr_123\"`.",
"title": "Thread Id",
"type": "string"
},
"time_used_seconds": {
"description": "Wall-clock seconds spent on this goal, e.g. `60`.",
"minimum": 0.0,
"title": "Time Used Seconds",
"type": "integer"
},
"token_budget": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "Optional token budget, e.g. `40000`. `None` means no explicit budget is set.",
"title": "Token Budget"
},
"tokens_used": {
"description": "Tokens spent while pursuing this goal, e.g. `1024`.",
"minimum": 0.0,
"title": "Tokens Used",
"type": "integer"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unix timestamp when the goal was last updated, e.g. `1776272460`. `None` when not provided by Codex.",
"title": "Updated At"
}
},
"required": [
"thread_id",
"objective",
"status",
"tokens_used",
"time_used_seconds"
],
"title": "CodexGoalObject",
"type": "object"
},
"CodexGoalResponse": {
"description": "Response body for reading or setting a Codex-native session goal.",
"properties": {
"goal": {
"anyOf": [
{
"$ref": "#/components/schemas/CodexGoalObject"
},
{
"type": "null"
}
],
"description": "Current goal state, or `None` when the session has no persisted Codex goal."
}
},
"required": [
"goal"
],
"title": "CodexGoalResponse",
"type": "object"
},
"CompactionCompletedEvent": {
"description": "Conversation history compaction has finished.\n\nEmitted after compaction completes \u2014 either by the server after\n`compact_conversation_now()` (explicit `/compact`), or by a\nharness that compacted its own internal context. Clients that\nrendered a \"Compacting\u2026\" spinner on\n`CompactionInProgressEvent` should upgrade it to the\npermanent \"Conversation compacted\" marker on this event.\n\nWhen emitted by a harness, `summary` and `summary_model`\nare populated so the runner can persist a compaction item for\nsession resume. When emitted by the server's explicit\n`/compact` path, those fields are `None`.",
"properties": {
"compacted_messages": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Compacted Messages"
},
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Text summary of the compacted conversation, or `None` for server-side compaction (already persisted).",
"title": "Summary"
},
"summary_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Model used for summarization, or `None` if truncation-based or server-side.",
"title": "Summary Model"
},
"total_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Tiktoken estimate of the post-compaction message context size, e.g. `8421`. Used by clients to update the context-ring immediately without waiting for the next `response.completed` usage report. `None` when token counting is unavailable.",
"title": "Total Tokens"
},
"type": {
"const": "response.compaction.completed",
"description": "Always `\"response.compaction.completed\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
],
"title": "CompactionCompletedEvent",
"type": "object"
},
"CompactionData": {
"description": "Data payload for a compaction summary item.\n\nStored as a conversation item of `type=\"compaction\"`.\nThe summary covers all items from the start of the\nconversation (or the previous compaction item) through\nthe item identified by `last_item_id`.",
"properties": {
"compacted_messages": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Compacted Messages"
},
"last_item_id": {
"description": "The item ID (inclusive) of the last conversation item covered by this summary, e.g. `\"msg_abc123\"`. Items at positions <= this item are summarized and do not need to be loaded for prompt construction.",
"title": "Last Item Id",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The model used to generate the summary, e.g. `\"openai/gpt-4o\"`.",
"title": "Model"
},
"summary": {
"description": "The LLM-generated summary text covering all conversation items up through `last_item_id`, e.g. `\"User asked to analyze a dataset. Agent loaded data.csv and computed statistics.\"`.",
"title": "Summary",
"type": "string"
},
"token_count": {
"description": "Approximate token count of the summary text, for budget tracking, e.g. `342`.",
"title": "Token Count",
"type": "integer"
},
"window_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Window Id"
}
},
"required": [
"summary",
"last_item_id",
"token_count"
],
"title": "CompactionData",
"type": "object"
},
"CompactionFailedEvent": {
"description": "Conversation history compaction failed.\n\nEmitted by `omnigent/server/routes/sessions.py` when\n`compact_conversation_now()` raises. Clients that rendered a\n\"Compacting\u2026\" spinner on `CompactionInProgressEvent`\nshould dismiss it without leaving a permanent marker, since the\nconversation history was not modified.",
"properties": {
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"type": {
"const": "response.compaction.failed",
"description": "Always `\"response.compaction.failed\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
],
"title": "CompactionFailedEvent",
"type": "object"
},
"CompactionInProgressEvent": {
"description": "Conversation history is being compacted.\n\nEmitted by `omnigent/runtime/compaction.py` while a\ncompaction step runs so clients can render a \"summarizing\nhistory\u2026\" indicator. Wire shape matches `compaction.py:765`.",
"properties": {
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"type": {
"const": "response.compaction.in_progress",
"description": "Always `\"response.compaction.in_progress\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
],
"title": "CompactionInProgressEvent",
"type": "object"
},
"CompletedEvent": {
"description": "Terminal event for a successfully completed turn.\n\nCarries the final\n`omnigent.server.schemas.ResponseObject`.",
"properties": {
"response": {
"$ref": "#/components/schemas/ResponseObject",
"description": "The final response object with `status=\"completed\"`."
},
"sequence_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence Number"
},
"type": {
"const": "response.completed",
"description": "Always `\"response.completed\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"response"
],
"title": "CompletedEvent",
"type": "object"
},
"ConversationDeleted": {
"description": "Confirmation payload returned after deleting a conversation.",
"properties": {
"deleted": {
"default": true,
"description": "Always `True`.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "ID of the deleted conversation, e.g. `\"conv_abc123\"`.",
"title": "Id",
"type": "string"
},
"object": {
"default": "conversation.deleted",
"description": "Fixed resource type, always `\"conversation.deleted\"`.",
"title": "Object",
"type": "string"
}
},
"required": [
"id"
],
"title": "ConversationDeleted",
"type": "object"
},
"ConversationItem": {
"description": "A persisted item with a store-assigned ID.",
"properties": {
"created_at": {
"description": "Unix epoch timestamp of creation.",
"title": "Created At",
"type": "integer"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Identity of the human actor who authored this item, or `None` for agent/tool/system items and single-user mode. Lets owner and collaborator messages be distinguished.",
"title": "Created By"
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/MessageData"
},
{
"$ref": "#/components/schemas/FunctionCallData"
},
{
"$ref": "#/components/schemas/FunctionCallOutputData"
},
{
"$ref": "#/components/schemas/ErrorData"
},
{
"$ref": "#/components/schemas/ReasoningData"
},
{
"$ref": "#/components/schemas/CompactionData"
},
{
"$ref": "#/components/schemas/NativeToolData"
},
{
"$ref": "#/components/schemas/ResourceEventData"
},
{
"$ref": "#/components/schemas/RoutingDecisionData"
},
{
"$ref": "#/components/schemas/SlashCommandData"
},
{
"$ref": "#/components/schemas/TerminalCommandData"
}
],
"description": "The typed data payload (MessageData, etc.).",
"title": "Data"
},
"id": {
"description": "Store-assigned item ID, e.g. `\"msg_abc123\"`.",
"title": "Id",
"type": "string"
},
"response_id": {
"description": "The task/response ID this item belongs to.",
"title": "Response Id",
"type": "string"
},
"status": {
"description": "Item status, e.g. `\"completed\"`.",
"title": "Status",
"type": "string"
},
"type": {
"description": "Item type, e.g. `\"message\"`, `\"function_call\"`.",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"type",
"status",
"response_id",
"created_at",
"data"
],
"title": "ConversationItem",
"type": "object"
},
"ConversationRef": {
"description": "Lightweight reference to a conversation, used in request and\nresponse bodies where only the conversation ID is needed.",
"properties": {
"id": {
"description": "Conversation identifier, e.g. `\"conv_abc123\"`.",
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "ConversationRef",
"type": "object"
},
"CreateDefaultPolicyRequest": {
"description": "Request body for `POST /v1/policies`.",
"properties": {
"factory_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"description": "Optional dict of kwargs passed to the handler when it is a factory function. Only valid for `type=\"python\"`, e.g. `{\"limit\": 10}`.",
"title": "Factory Params"
},
"handler": {
"description": "Dotted import path (python) or HTTPS URL (url), e.g. `\"github_mcp_policy.block_non_misc_push\"` or `\"https://example.com/policies/eval\"`.",