-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathmodels.py
More file actions
1623 lines (1275 loc) · 61.1 KB
/
models.py
File metadata and controls
1623 lines (1275 loc) · 61.1 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
"""
MoltGrid Pydantic Models — all request/response BaseModel subclasses.
Extracted from main.py to serve as the shared models module for router modules.
"""
import re
from typing import Optional, List, Dict, Union, Any, Literal
from pydantic import AliasChoices, BaseModel, ConfigDict, Field, validator
from config import MAX_MEMORY_VALUE_SIZE, MAX_QUEUE_PAYLOAD_SIZE
# ═══════════════════════════════════════════════════════════════════════════════
# AUTH MODELS
# ═══════════════════════════════════════════════════════════════════════════════
def _validate_password_strength(v):
"""Shared password strength validator for signup, reset, and change flows."""
if not re.search(r'[A-Z]', v):
raise ValueError('Password must contain at least one uppercase letter')
if not re.search(r'[0-9]', v):
raise ValueError('Password must contain at least one number')
if not re.search(r'[!@#$%^&*()_+\-=\[\]{};:\'",.<>?/\\|`~]', v):
raise ValueError('Password must contain at least one special character')
if not re.match(r'^[\x20-\x7E]+$', v):
raise ValueError('Password must contain only standard ASCII characters')
return v
class SignupRequest(BaseModel):
email: str = Field(..., max_length=256)
password: str = Field(..., min_length=8, max_length=128)
display_name: Optional[str] = Field(None, max_length=30)
promo_optin: bool = False
turnstile_token: Optional[str] = None
@validator('password')
def password_strength(cls, v):
return _validate_password_strength(v)
class LoginRequest(BaseModel):
email: str = Field(..., max_length=256)
password: str = Field(..., max_length=128)
totp_code: Optional[str] = Field(None, max_length=16)
turnstile_token: Optional[str] = None
class ForgotPasswordRequest(BaseModel):
email: str = Field(..., max_length=256)
class ResetPasswordRequest(BaseModel):
token: str
new_password: str = Field(..., min_length=8, max_length=128)
@validator('new_password')
def password_strength(cls, v):
return _validate_password_strength(v)
class TOTP2FAVerifyRequest(BaseModel):
code: str = Field(..., min_length=6, max_length=8)
class TOTP2FADisableRequest(BaseModel):
code: str = Field(..., min_length=6, max_length=16)
# ═══════════════════════════════════════════════════════════════════════════════
# USER / DASHBOARD MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class NotificationPreferencesRequest(BaseModel):
welcome: Optional[bool] = None
quota_alerts: Optional[bool] = None
weekly_digest: Optional[bool] = None
class MemoryVisibilityRequest(BaseModel):
model_config = ConfigDict(extra='ignore')
key: Optional[str] = Field(None, max_length=256)
visibility: Literal["private", "public", "shared"] = Field(..., description="private | public | shared")
shared_agents: List[str] = Field(default_factory=list)
class MemoryBulkVisibilityRequest(BaseModel):
entries: List[dict]
visibility: str = Field(..., description="private | public | shared")
shared_agents: List[str] = Field(default_factory=list)
class TransferRequest(BaseModel):
to_email: str = Field(..., max_length=256)
class UserScheduleRequest(BaseModel):
cron_expr: str = Field(..., max_length=128)
queue_name: str = Field("default", max_length=64)
payload: str = Field("{}", max_length=100_000)
priority: int = Field(0, ge=0, le=10)
class UserScheduleUpdateRequest(BaseModel):
enabled: Optional[bool] = None
cron_expr: Optional[str] = Field(None, max_length=128)
# ═══════════════════════════════════════════════════════════════════════════════
# INTEGRATION MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class IntegrationCreateRequest(BaseModel):
platform: str = Field(..., max_length=64, description="Platform name, e.g. 'moltbook', 'slack'")
config: Optional[dict] = Field(None, description="Platform-specific config JSON")
status: str = Field("active", max_length=32)
class IntegrationStatusItem(BaseModel):
integration_id: str
agent_id: str
platform: str
status: str
last_sync_at: str
event_count: int
class IntegrationStatusResponse(BaseModel):
integrations: List[IntegrationStatusItem]
# ═══════════════════════════════════════════════════════════════════════════════
# WEBHOOK MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class WebhookRegisterRequest(BaseModel):
url: str = Field(..., max_length=2048, description="HTTPS callback URL")
event_types: List[str] = Field(..., min_length=1, description="Events to subscribe to: message.received, job.completed")
secret: Optional[str] = Field(None, max_length=128, description="Shared secret for HMAC signature verification")
class WebhookResponse(BaseModel):
webhook_id: str
url: str
event_types: List[str]
active: bool
created_at: str
# ═══════════════════════════════════════════════════════════════════════════════
# BILLING MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class CheckoutRequest(BaseModel):
tier: str = Field(..., description="Subscription tier: hobby, team, or scale")
# ═══════════════════════════════════════════════════════════════════════════════
# REGISTRATION MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class RegisterRequest(BaseModel):
name: str = Field(..., min_length=1, max_length=64, description="Display name for your agent")
template_id: Optional[str] = Field(None, max_length=64, description="Optional template ID to pre-load starter code into agent memory")
class RegisterResponse(BaseModel):
agent_id: str
api_key: str
message: str
# ═══════════════════════════════════════════════════════════════════════════════
# MOLTBOOK MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class MoltBookEventRequest(BaseModel):
event_type: str = Field(..., max_length=64, description="e.g. 'post', 'reply', 'upvote'")
moltbook_url: Optional[str] = Field(None, max_length=512, description="Deep link to the MoltBook post")
metadata: Optional[dict] = Field(None, description="Additional event metadata")
class MoltBookRegisterRequest(BaseModel):
moltbook_user_id: str = Field(..., max_length=128)
display_name: str = Field(..., max_length=64)
# ═══════════════════════════════════════════════════════════════════════════════
# ONBOARDING MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class OnboardingResponse(BaseModel):
steps: List[dict]
progress: int
total: int
reward: str
# ═══════════════════════════════════════════════════════════════════════════════
# AGENT HEARTBEAT / LIVENESS MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class HeartbeatRequest(BaseModel):
status: Literal["online", "busy", "idle", "offline"] = Field(
"online", description="Agent status: online, busy, idle, offline"
)
metadata: Optional[dict] = Field(None, description="Optional metadata blob (max 4KB)")
# ═══════════════════════════════════════════════════════════════════════════════
# MEMORY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class MemorySetRequest(BaseModel):
model_config = ConfigDict(extra='ignore', populate_by_name=True)
key: str = Field(..., min_length=1, max_length=256)
value: str = Field(..., min_length=1, max_length=MAX_MEMORY_VALUE_SIZE)
ttl_seconds: Optional[int] = Field(None, ge=60, le=2592000, validation_alias=AliasChoices("ttl_seconds", "ttl"), description="Auto-expire after N seconds (60s-30d)")
visibility: str = Field("private", description="private | public | shared")
shared_agents: List[str] = Field(default_factory=list)
class MemoryGetResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
key: str
value: str
namespace: str
updated_at: str
expires_at: Optional[str]
class MemoryKeyEntry(BaseModel):
model_config = ConfigDict(extra='ignore')
key: str
size_bytes: int
updated_at: str
expires_at: Optional[str]
class MemoryListResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
namespace: str
keys: List[MemoryKeyEntry]
count: int
# ═══════════════════════════════════════════════════════════════════════════════
# HEALTH / STATS MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class HealthComponentStatus(BaseModel):
model_config = ConfigDict(extra='ignore')
status: str # "ok" | "degraded" | "error"
detail: Optional[str] = None
class HealthComponents(BaseModel):
model_config = ConfigDict(extra='ignore')
database: HealthComponentStatus
relay: HealthComponentStatus
websocket: HealthComponentStatus
sse: HealthComponentStatus
class HealthStatsResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
registered_agents: int
public_agents: int
total_jobs: int
memory_keys_stored: int
shared_memory_keys: int
messages_relayed: int
active_webhooks: int
active_schedules: int
websocket_connections: int
class HealthResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
status: str
version: str
stats: Optional[HealthStatsResponse] = None
components: Optional[HealthComponents] = None
timestamp: str
retry_after_seconds: Optional[int] = None
# ═══════════════════════════════════════════════════════════════════════════════
# ERROR RESPONSE MODEL (OPS-01, OPS-05)
# ═══════════════════════════════════════════════════════════════════════════════
class ErrorResponse(BaseModel):
"""Structured error response returned for all 4xx and 5xx status codes."""
error: str
message: str
request_id: Optional[str] = None
timestamp: str
retry_after_seconds: Optional[int] = None
# ═══════════════════════════════════════════════════════════════════════════════
# QUEUE MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class QueueJobEntry(BaseModel):
model_config = ConfigDict(extra='ignore')
job_id: str
status: str
priority: int
created_at: str
completed_at: Optional[str]
class QueueListResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
queue_name: str
jobs: List[QueueJobEntry]
count: int
# ═══════════════════════════════════════════════════════════════════════════════
# SCHEDULE MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class ScheduleEntry(BaseModel):
model_config = ConfigDict(extra='ignore')
task_id: str
cron_expr: str
queue_name: str
priority: int
enabled: bool
next_run_at: Optional[str]
last_run_at: Optional[str]
run_count: Optional[int]
created_at: str
class ScheduleListResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
schedules: List[ScheduleEntry]
count: int
class QueueSubmitRequest(BaseModel):
model_config = ConfigDict(populate_by_name=True)
payload: Union[str, dict] = Field(..., description="Job payload (string or JSON object)")
queue_name: str = Field("default", max_length=64, validation_alias=AliasChoices("queue_name", "queue"))
priority: int = Field(0, ge=0, le=10, description="Higher = processed first")
max_attempts: int = Field(1, ge=1, le=10, description="Max retry attempts before dead-lettering")
retry_delay_seconds: int = Field(0, ge=0, le=3600, description="Seconds to wait before retrying")
class QueueJobResponse(BaseModel):
job_id: str
status: str
claimed_by: Optional[str] = None
queue_name: str
priority: int
created_at: str
started_at: Optional[str]
completed_at: Optional[str]
result: Optional[str]
class QueueFailRequest(BaseModel):
model_config = ConfigDict(populate_by_name=True)
reason: str = Field("", max_length=1000, validation_alias=AliasChoices("reason", "fail_reason", "error"), description="Why the job failed")
class QueueCompleteRequest(BaseModel):
model_config = ConfigDict(extra='ignore')
result: Optional[Union[str, dict]] = Field(None, description="Job completion result")
class TaskCompleteRequest(BaseModel):
model_config = ConfigDict(extra='ignore')
result: Optional[Union[str, dict]] = Field(None, description="Task completion result")
# ═══════════════════════════════════════════════════════════════════════════════
# RELAY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class RelayMessage(BaseModel):
to_agent: str = Field(..., description="Recipient agent_id")
channel: str = Field("direct", max_length=64)
payload: str = Field(..., min_length=1, max_length=10_000)
# ═══════════════════════════════════════════════════════════════════════════════
# TEXT UTILITY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class TextProcessRequest(BaseModel):
text: str = Field(..., max_length=50_000)
operation: str = Field(..., description="One of: word_count, char_count, extract_urls, extract_emails, tokenize_sentences, deduplicate_lines, hash_sha256, base64_encode, base64_decode")
# ═══════════════════════════════════════════════════════════════════════════════
# SCHEDULED TASK MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class ScheduledTaskRequest(BaseModel):
cron_expr: str = Field(..., max_length=128, description="Cron expression (5-field: min hour dom mon dow)")
queue_name: str = Field("default", max_length=64)
payload: str = Field(..., min_length=1, max_length=MAX_QUEUE_PAYLOAD_SIZE)
priority: int = Field(0, ge=0, le=10)
class ScheduleUpdateRequest(BaseModel):
model_config = ConfigDict(extra='ignore')
enabled: Optional[bool] = Field(None, description="Enable or disable the schedule")
cron_expr: Optional[str] = Field(None, max_length=128, description="Updated cron expression")
queue_name: Optional[str] = Field(None, max_length=64)
priority: Optional[int] = Field(None, ge=0, le=10)
class ScheduledTaskResponse(BaseModel):
task_id: str
cron_expr: str
queue_name: str
payload: str
priority: int
enabled: bool
next_run_at: str
created_at: str
# ═══════════════════════════════════════════════════════════════════════════════
# VECTOR MEMORY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class VectorUpsertRequest(BaseModel):
key: str = Field(..., min_length=1, max_length=256)
text: str = Field(..., min_length=1, max_length=10000, description="Text to embed")
namespace: str = Field("default", max_length=64)
metadata: Optional[dict] = Field(None, description="Optional metadata (stored as JSON)")
importance: float = Field(0.5, ge=0.0, le=1.0, description="Importance weight (0.0-1.0) for composite scoring")
class VectorSearchRequest(BaseModel):
model_config = ConfigDict(extra='ignore', populate_by_name=True)
query: str = Field(..., max_length=10000, description="Search query to embed")
namespace: str = Field("default", max_length=64)
limit: int = Field(5, ge=1, le=100, validation_alias=AliasChoices("limit", "top_k"), description="Number of results to return")
min_similarity: float = Field(0.0, ge=0.0, le=1.0, validation_alias=AliasChoices("min_similarity", "min_score"), description="Minimum cosine similarity threshold")
scoring: str = Field("cosine", description="Scoring mode: 'cosine' (similarity only) or 'composite' (0.4*recency + 0.2*importance + 0.4*cosine)")
# ═══════════════════════════════════════════════════════════════════════════════
# SHARED MEMORY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class SharedMemorySetRequest(BaseModel):
namespace: str = Field(..., max_length=64, description="Public namespace name")
key: str = Field(..., min_length=1, max_length=256)
value: str = Field(..., max_length=MAX_MEMORY_VALUE_SIZE)
description: Optional[str] = Field(None, max_length=256, description="Human-readable description of this entry")
ttl_seconds: Optional[int] = Field(None, ge=60, le=2592000)
# ═══════════════════════════════════════════════════════════════════════════════
# DIRECTORY MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class DirectoryUpdateRequest(BaseModel):
description: Optional[str] = Field(None, max_length=512, description="What your agent does")
capabilities: Optional[List[str]] = Field(None, max_length=20, description="List of capabilities")
skills: Optional[List[str]] = Field(None, max_length=20, description="Technical skills (e.g. python, data_analysis)")
interests: Optional[List[str]] = Field(None, max_length=20, description="Topics/domains of interest (e.g. AI, finance)")
public: Optional[bool] = Field(None, description="Whether to list in the public directory. Omit to keep current value.")
# ═══════════════════════════════════════════════════════════════════════════════
# STATUS / COLLABORATION MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class StatusUpdateRequest(BaseModel):
available: Optional[bool] = Field(None, description="Whether agent is available for work")
looking_for: Optional[List[str]] = Field(None, description="Capabilities this agent is seeking")
busy_until: Optional[str] = Field(None, description="ISO timestamp when agent becomes free")
class CollaborationRequest(BaseModel):
partner_agent: str = Field(..., description="Agent ID of the collaboration partner")
task_type: Optional[str] = Field(None, max_length=128)
outcome: str = Field(..., description="success, failure, or partial")
rating: int = Field(..., ge=1, le=5, description="Rating 1-5 for the partner")
# ═══════════════════════════════════════════════════════════════════════════════
# MARKETPLACE MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class MarketplaceCreateRequest(BaseModel):
title: str = Field(..., max_length=256)
description: Optional[str] = Field(None, max_length=5000)
category: Optional[str] = Field(None, max_length=64)
requirements: Optional[List[str]] = Field(None, description="Required capabilities")
reward_credits: int = Field(0, ge=0, le=10000)
priority: int = Field(0, ge=0, le=10)
estimated_effort: Optional[str] = Field(None, max_length=128)
tags: Optional[List[str]] = Field(None)
deadline: Optional[str] = Field(None, description="ISO timestamp deadline")
class MarketplaceDeliverRequest(BaseModel):
result: str = Field(..., max_length=50000)
class MarketplaceReviewRequest(BaseModel):
accept: bool = Field(...)
rating: Optional[int] = Field(None, ge=1, le=5)
# ═══════════════════════════════════════════════════════════════════════════════
# COORDINATION / SCENARIO MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class ScenarioCreateRequest(BaseModel):
name: Optional[str] = Field(None, max_length=128)
pattern: str = Field(..., description="One of: leader_election, consensus, load_balancing, pub_sub_fanout, task_auction")
agent_count: int = Field(..., ge=2, le=20)
timeout_seconds: int = Field(60, ge=5, le=300)
success_criteria: Optional[dict] = Field(None)
# ═══════════════════════════════════════════════════════════════════════════════
# PUBSUB MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class PubSubSubscribeRequest(BaseModel):
channel: str = Field(..., min_length=1, max_length=128, description="Channel name to subscribe to")
class PubSubPublishRequest(BaseModel):
channel: str = Field(..., min_length=1, max_length=128, description="Channel to publish to")
payload: str = Field(..., min_length=1, max_length=50_000, description="Message payload")
# ═══════════════════════════════════════════════════════════════════════════════
# ADMIN MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class AdminLoginRequest(BaseModel):
password: str
class AdminEmailRequest(BaseModel):
from_category: str = Field("transactional", description="transactional|support|marketing|founder")
to_email: str = Field(..., max_length=256)
subject: str = Field(..., max_length=256)
title: str = Field(..., max_length=256)
body_html: str = Field(...)
send: bool = Field(False, description="If true, actually send. If false, just preview.")
# ═══════════════════════════════════════════════════════════════════════════════
# SESSION MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class SessionCreateRequest(BaseModel):
metadata: Optional[dict] = Field(None, description="Session metadata (JSON object)")
title: Optional[str] = Field(None, max_length=256)
max_tokens: int = Field(128000, ge=1000, le=1000000)
class SessionAppendRequest(BaseModel):
role: str = Field(..., pattern="^(user|assistant|system|agent)$")
content: str = Field(..., min_length=1, max_length=1000000)
# ═══════════════════════════════════════════════════════════════════════════════
# CONTACT MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class ContactForm(BaseModel):
name: str = ""
email: str
subject: str = ""
message: str
turnstile_token: Optional[str] = None
# ═══════════════════════════════════════════════════════════════════════════════
# ORG MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class OrgCreateRequest(BaseModel):
name: str = Field(..., min_length=2, max_length=64)
slug: Optional[str] = Field(None, max_length=64, pattern="^[a-z0-9-]+$")
class OrgInviteRequest(BaseModel):
user_id: str = Field(..., max_length=64)
role: str = Field("member", pattern="^(owner|admin|member)$")
class OrgRoleUpdateRequest(BaseModel):
role: str = Field(..., pattern="^(owner|admin|member)$")
# ═══════════════════════════════════════════════════════════════════════════════
# EVENT STREAM MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class EventAckRequest(BaseModel):
event_ids: List[str]
class ObstacleCourseSubmitRequest(BaseModel):
stages_completed: List[int]
proof: str = ""
# ═══════════════════════════════════════════════════════════════════════════════
# RESPONSE MODELS — Pydantic response_model declarations for OpenAPI spec
# ═══════════════════════════════════════════════════════════════════════════════
# --- Shared ---
class MessageResponse(BaseModel):
message: str
class StatusResponse(BaseModel):
status: str
# --- Auth Response Models ---
class AuthSignupResponse(BaseModel):
user_id: str
token: str
message: str
class AuthLoginResponse(BaseModel):
user_id: Optional[str] = None
token: Optional[str] = None
requires_2fa: Optional[bool] = None
temp_token: Optional[str] = None
class AuthMeResponse(BaseModel):
user_id: str
email: str
display_name: Optional[str]
subscription_tier: Optional[str]
max_agents: int
max_api_calls: int
usage_count: int
agent_count: int
created_at: str
last_login: Optional[str]
class AuthRefreshResponse(BaseModel):
user_id: str
token: str
class AuthLogoutResponse(BaseModel):
status: str
class Auth2FASetupResponse(BaseModel):
secret: str
otpauth_uri: str
qr_code_url: str
class Auth2FAVerifyResponse(BaseModel):
enabled: bool
recovery_codes: List[str]
class Auth2FADisableResponse(BaseModel):
disabled: bool
class NotificationPreferencesUpdateResponse(BaseModel):
status: str
preferences: dict
class NotificationPreferencesGetResponse(BaseModel):
preferences: dict
class RotateKeyResponse(BaseModel):
status: str
agent_id: str
api_key: str
message: str
# --- Billing Response Models ---
class TierDetail(BaseModel):
name: str
price: int
max_agents: int
max_api_calls: int
features: List[str]
class PricingResponse(BaseModel):
tiers: Dict[str, TierDetail]
currency: str
billing_period: str
class CheckoutResponse(BaseModel):
checkout_url: str
class PortalResponse(BaseModel):
portal_url: str
class BillingStatusResponse(BaseModel):
tier: str
active: bool
usage_this_period: int
payment_failed: bool
stripe_subscription_id: Optional[str]
current_period_end: Optional[str]
cancel_at_period_end: bool
class TemplateItem(BaseModel):
template_id: str
name: str
description: Optional[str]
category: Optional[str]
starter_code: Optional[str]
class TemplateListResponse(BaseModel):
templates: List[TemplateItem]
class TemplateDetailResponse(BaseModel):
template_id: str
name: str
description: Optional[str]
category: Optional[str]
starter_code: Optional[str]
# --- Relay Response Models ---
class RelaySendResponse(BaseModel):
message_id: str
status: str
class RelayMessageItem(BaseModel):
message_id: str
from_agent: str
channel: str
payload: str
created_at: str
read_at: Optional[str] = None
class RelayInboxResponse(BaseModel):
channel: Optional[str] = None
messages: List[RelayMessageItem]
count: int
next_cursor: Optional[str] = None
class RelayMarkReadResponse(BaseModel):
message_id: str
status: str
# --- Message Delivery Tracking Models (Phase 42) ---
class MessageStatusResponse(BaseModel):
message_id: str
from_agent: str
to_agent: str
status: str
created_at: str
status_updated_at: Optional[str] = None
delivered_at: Optional[str] = None
read_at: Optional[str] = None
acted_at: Optional[str] = None
class MessageHop(BaseModel):
hop_id: str
hop: str
status: str
recorded_at: str
class MessageTraceResponse(BaseModel):
message_id: str
hops: List[MessageHop]
class DeadLetterMessageItem(BaseModel):
dl_id: str
to_agent: str
channel: str
fail_reason: str
created_at: str
class DeadLetterMessageListResponse(BaseModel):
messages: List[DeadLetterMessageItem]
count: int
# --- Webhook Response Models ---
class WebhookListItem(BaseModel):
webhook_id: str
url: str
event_types: List[str]
active: bool
created_at: str
class WebhookListResponse(BaseModel):
webhooks: List[WebhookListItem]
count: int
class WebhookDeleteResponse(BaseModel):
status: str
webhook_id: str
class WebhookTestResponse(BaseModel):
delivery_id: str
status: str
error: Optional[str]
# --- Queue Response Models ---
class QueueSubmitResponse(BaseModel):
job_id: str
status: str
queue_name: str
max_attempts: int
class DeadLetterJobItem(BaseModel):
model_config = ConfigDict(extra='ignore')
job_id: str
queue_name: str
priority: int
attempt_count: Optional[int]
max_attempts: Optional[int]
fail_reason: Optional[str]
created_at: str
failed_at: Optional[str]
moved_at: Optional[str]
class DeadLetterListResponse(BaseModel):
jobs: List[DeadLetterJobItem]
count: int
class QueueClaimResponse(BaseModel):
job_id: Optional[str] = None
payload: Optional[str] = None
priority: Optional[int] = None
status: Optional[str] = None
queue_name: Optional[str] = None
class QueueCompleteResponse(BaseModel):
job_id: str
status: str
class QueueFailResponse(BaseModel):
job_id: str
status: str
attempts: int
max_attempts: int
next_retry_at: Optional[str] = None
class QueueReplayResponse(BaseModel):
job_id: str
status: str
replayed_at: str
# --- Schedule Response Models ---
class ScheduleGetResponse(BaseModel):
model_config = ConfigDict(extra='ignore')
task_id: str
agent_id: str
cron_expr: str
queue_name: str
payload: str
priority: int
enabled: bool
next_run_at: Optional[str]
last_run_at: Optional[str]
run_count: Optional[int]
created_at: str
class ScheduleToggleResponse(BaseModel):
task_id: str
enabled: bool
class ScheduleDeleteResponse(BaseModel):
status: str
task_id: str
# --- Events Response Models ---
class EventItem(BaseModel):
event_id: str
event_type: str
payload: dict
created_at: str
class EventAckResponse(BaseModel):
acknowledged: int
# --- PubSub Response Models ---
class PubSubSubscribeResponse(BaseModel):
channel: str
status: str
subscribed_at: Optional[str] = None
class PubSubUnsubscribeResponse(BaseModel):
channel: str
status: str
class PubSubSubscriptionItem(BaseModel):
channel: str
subscribed_at: str
class PubSubSubscriptionsResponse(BaseModel):
subscriptions: List[PubSubSubscriptionItem]
count: int
class PubSubPublishResponse(BaseModel):
message_id: str
channel: str
subscribers_notified: int
created_at: str
class PubSubChannelItem(BaseModel):
channel: str
subscriber_count: int
class PubSubChannelsResponse(BaseModel):
channels: List[PubSubChannelItem]
count: int
# --- Memory Response Models ---
class MemoryCrossAgentReadResponse(BaseModel):
key: str
value: str
namespace: str
visibility: str
updated_at: str
expires_at: Optional[str]
class MemoryVisibilityResponse(BaseModel):
status: str
key: str
visibility: str
class MemorySetResponse(BaseModel):
status: str
key: str
namespace: str
visibility: str
class MemoryDeleteResponse(BaseModel):
status: str
key: str
# ── BATCH MODELS ──────────────────────────────────────────────────────────────
class MemoryBatchItem(BaseModel):
"""Single item in a memory batch request."""
model_config = ConfigDict(extra='ignore', populate_by_name=True)
key: str = Field(..., min_length=1, max_length=256)
value: str = Field(..., min_length=1, max_length=MAX_MEMORY_VALUE_SIZE)
ttl_seconds: Optional[int] = Field(None, ge=60, le=2592000)
visibility: str = Field("private")
shared_agents: List[str] = Field(default_factory=list)
class MemoryBatchRequest(BaseModel):
items: List[MemoryBatchItem] = Field(..., min_length=1, max_length=100)
class MemoryBatchResultItem(BaseModel):
key: str
success: bool
status: str # "stored" or "error"
error: Optional[str] = None
class MemoryBatchResponse(BaseModel):
results: List[MemoryBatchResultItem]
total: int
succeeded: int
failed: int
class QueueBatchItem(BaseModel):
"""Single item in a queue batch request."""
model_config = ConfigDict(populate_by_name=True)
payload: Union[str, dict] = Field(..., description="Job payload")
queue_name: str = Field("default", max_length=64)
priority: int = Field(0, ge=0, le=10)
max_attempts: int = Field(1, ge=1, le=10)
retry_delay_seconds: int = Field(0, ge=0, le=3600)
class QueueBatchRequest(BaseModel):
items: List[QueueBatchItem] = Field(..., min_length=1, max_length=100)
class QueueBatchResultItem(BaseModel):
job_id: Optional[str] = None
success: bool
status: str # "pending" or "error"
queue_name: Optional[str] = None
error: Optional[str] = None
class QueueBatchResponse(BaseModel):
results: List[QueueBatchResultItem]
total: int
succeeded: int
failed: int
class MemoryMetaResponse(BaseModel):
key: str
namespace: str
writer: str
version: int
created_at: str
updated_at: str
expires_at: Optional[str] = None
class MemoryHistoryEntry(BaseModel):
version: int
value: str
changed_by: str
changed_at: str
class MemoryHistoryResponse(BaseModel):
key: str
namespace: str
history: List[MemoryHistoryEntry]
count: int
# ═══════════════════════════════════════════════════════════════════════════════
# DIRECTORY RESPONSE MODELS
# ═══════════════════════════════════════════════════════════════════════════════
class HeartbeatResponse(BaseModel):
agent_id: str
status: str