forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeveloper.py
More file actions
2511 lines (2163 loc) · 95.8 KB
/
Copy pathdeveloper.py
File metadata and controls
2511 lines (2163 loc) · 95.8 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
import uuid
from datetime import datetime, timezone, timedelta
from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
from enum import Enum
from typing import Any, List, Literal, Optional
from fastapi import APIRouter, HTTPException, Depends, Query, Request
from pydantic import AliasChoices, BaseModel, ConfigDict, Field, ValidationError, field_validator
import database.folders as folders_db
import database.conversations as conversations_db
import database.action_items as action_items_db
import database.goals as goals_db
import database.users as users_db
import database.daily_summaries as daily_summaries_db
from database._client import db
from database.firestore_read_metrics import FirestoreReadSite
from models.folder import Folder
from models.goal import GoalHistoryEntryResponse, GoalMetric
from models.daily_summary import DailySummariesResponse, DailySummaryResponse
from utils.client_device import resolve_client_device_from_request
from utils.goals_response import normalize_goal_history_entry
from models.memories import MemoryCategory, Memory, MemoryDB
from models.client_processing import ClientProcessing
from models.conversation import (
Conversation as OmiConversation,
CreateConversation,
ExternalIntegrationCreateConversation,
)
from models.conversation_enums import (
CategoryEnum,
ConversationSource,
ConversationStatus,
ExternalIntegrationConversationSource,
)
from models.geolocation import Geolocation, GeolocationInput, validated_geolocation_or_none
from models.structured import Structured
from utils.conversations.render import populate_speaker_names, populate_folder_names
from models.transcript_segment import TranscriptSegment
from dependencies import (
ApiKeyAuth,
check_conversation_transcript_read_limit,
get_auth_with_conversation_detail_read,
get_auth_with_conversations_read,
get_uid_with_conversations_read,
get_uid_with_conversations_read_ask,
get_uid_with_conversations_write,
get_developer_memory_default_memory_batch_write_context,
get_developer_memory_default_memory_read_context,
get_developer_memory_default_memory_write_context,
get_uid_with_action_items_read,
get_uid_with_action_items_write,
get_uid_with_goals_read,
get_uid_with_goals_write,
)
from utils.apps import update_personas_async
from utils.log_sanitizer import sanitize
from utils.other.endpoints import with_rate_limit, get_current_user_uid
from utils.notifications import send_action_item_data_message, sync_action_item_reminder
from utils.conversations.process_conversation import process_conversation
from utils.conversations.projection_payload import (
client_processing_mutation,
omit_null_processing_state,
sanitize_untrusted_provenance_field,
strip_client_processing,
)
from utils.conversations.transcript_hash import (
stored_transcript_segment,
transcript_sha256,
transcript_sha256_for_binding,
)
from utils.conversations import lifecycle as lifecycle_service
from utils.conversations.location import resolve_geolocation
from utils.conversations.search import ConversationSearchUnavailableError, search_conversations
from utils.conversations.mcp_transcript_search import (
merge_summary_and_transcript_ids,
resolve_mcp_conversation_search_ids,
)
import database.vector_db as vector_db
from utils.conversations.factory import deserialize_conversations
from utils.llm.chat import qa_rag
from utils.conversations.meeting_receipt import (
projected_meeting_treatment_eligible,
record_and_persist_finalized_meeting_receipt,
)
from utils.executors import postprocess_executor
from utils.request_validation import HistoryDays
from utils.llm.memories import identify_category_for_memory
from utils.memory.memory_service import MemoryService, fetch_memory_dict
from testing.parity_pack_v0.live_capture import capture_memory_write
from utils.memory.memory_system import MemorySystem
from utils.memory.product_authorization import (
ProductAuthorizationContext,
authorize_memory_external_default_memory_read,
authorize_memory_external_default_memory_write,
)
import logging
logger = logging.getLogger(__name__)
router = APIRouter()
FROM_SEGMENTS_CLAIM_STALE_AFTER = timedelta(minutes=15)
_FROM_SEGMENTS_CONVERSATION_NAMESPACE = uuid.UUID('fb2f1f36-3c84-47a4-9c62-b3f6fdb3fd13')
class DeveloperSuccessResponse(BaseModel):
success: bool
DEVELOPER_MEMORY_ACCESS_NOT_READY = 'developer_memory_access_not_ready'
def _developer_memory_access_not_ready_detail(reason: Optional[str]) -> dict:
return {
'enabled': False,
'code': DEVELOPER_MEMORY_ACCESS_NOT_READY,
'message': (
'Developer Memory API access is not enabled for this account. '
'Your API key can be valid and correctly scoped; this endpoint also requires server-side memory '
'readiness. Try again after access is enabled, or contact Omi support if it remains unavailable.'
),
'reason': reason,
'consumer': 'developer_api',
'archive_default_visible': False,
'archive_capability': False,
}
def _developer_request_ip(request: Request) -> Optional[str]:
client = getattr(request, 'client', None)
if not client:
return None
return client.host
def _audit_developer_read(
*,
request: Optional[Request],
auth: ApiKeyAuth,
operation: str,
status: int,
limit: Optional[int] = None,
offset: Optional[int] = None,
include_transcript: Optional[bool] = None,
returned_count: Optional[int] = None,
resource_id: Optional[str] = None,
):
if request is None or not hasattr(request, 'url') or not hasattr(request, 'headers'):
return
logger.info(
"developer_api_read operation=%s path=%s status=%s uid=%s app_id=%s key_id=%s remote_ip=%s "
"user_agent=%s limit=%s offset=%s include_transcript=%s returned_count=%s resource_id=%s",
operation,
request.url.path,
status,
auth.uid,
auth.app_id or 'unknown_app',
auth.key_id or 'unknown_key',
_developer_request_ip(request),
sanitize(request.headers.get('user-agent')),
limit,
offset,
include_transcript,
returned_count,
sanitize(resource_id) if resource_id else None,
)
# ******************************************************
# *********************** MEMORIES *********************
# ******************************************************
def _coerce_required_memory_id(value) -> str:
if not value and value != 0:
raise ValueError('id is required')
return str(value)
def _coerce_optional_memory_datetime(value) -> Optional[datetime]:
if value in [None, '']:
return None
if isinstance(value, datetime):
return value
if isinstance(value, str):
try:
return datetime.fromisoformat(value.replace('Z', '+00:00'))
except ValueError:
return None
if isinstance(value, (int, float)) and not isinstance(value, bool):
try:
return datetime.fromtimestamp(value, tz=timezone.utc)
except (OSError, OverflowError, ValueError):
return None
return None
class DeveloperMemory(BaseModel):
model_config = ConfigDict(title='DeveloperMemory')
id: str
content: str = ''
category: MemoryCategory = MemoryCategory.interesting
visibility: Optional[str] = 'private'
tags: List[str] = Field(default_factory=list)
created_at: Optional[datetime] = None
updated_at: Optional[datetime] = None
manually_added: bool = False
reviewed: bool = False
user_review: Optional[bool] = None
edited: bool = False
scoring: Optional[str] = None
@field_validator('id', mode='before')
def coerce_id(cls, value):
return _coerce_required_memory_id(value)
@field_validator('content', mode='before')
def coerce_content(cls, value):
if value is None:
return ''
return str(value)
@field_validator('category', mode='before')
def coerce_category(cls, value):
if isinstance(value, MemoryCategory):
return value
try:
return MemoryCategory(value)
except (TypeError, ValueError):
return MemoryCategory.interesting
@field_validator('visibility', mode='before')
def coerce_visibility(cls, value):
return value if value in ['public', 'private'] else 'private'
@field_validator('tags', mode='before')
def coerce_tags(cls, value):
if not isinstance(value, list):
return []
return [str(tag) for tag in value if tag is not None]
@field_validator('created_at', 'updated_at', mode='before')
def coerce_datetime(cls, value):
return _coerce_optional_memory_datetime(value)
@field_validator('manually_added', 'reviewed', 'edited', mode='before')
def coerce_bool(cls, value):
if isinstance(value, bool):
return value
if value in [None, '']:
return False
if isinstance(value, str):
return value.lower() in ['true', '1', 'yes']
return bool(value)
@field_validator('user_review', mode='before')
def coerce_optional_bool(cls, value):
if value in [None, '']:
return None
if isinstance(value, bool):
return value
if isinstance(value, str):
return value.lower() in ['true', '1', 'yes']
return bool(value)
@field_validator('scoring', mode='before')
def coerce_scoring(cls, value):
if value is None:
return None
return str(value)
class DeveloperMemoryVectorItem(BaseModel):
model_config = ConfigDict(extra='allow')
id: str
content: str = ''
category: Optional[str] = None
relevance_score: Optional[float] = None
class DeveloperMemoryVectorPolicy(BaseModel):
consumer: str
app_has_default_memory_grant: bool
archive_capability: bool
raw_provenance_capability: bool
class DeveloperMemoryVectorSearchResponse(BaseModel):
items: List[DeveloperMemoryVectorItem] = Field(default_factory=list)
returned_count: int
archive_default_visible: bool
policy: DeveloperMemoryVectorPolicy
# Backward-compatible name used by unit tests and older docs.
CleanerMemory = DeveloperMemory
class CreateMemoryRequest(BaseModel):
model_config = ConfigDict(title='CreateMemoryRequest')
content: str = Field(description="The content of the memory", min_length=1, max_length=500)
category: Optional[MemoryCategory] = Field(
default=None, description="Memory category: interesting, system, or manual (auto-categorized if not provided)"
)
visibility: str = Field(default='private', description="Visibility: public or private")
tags: List[str] = Field(default=[], description="Tags associated with the memory")
class UpdateMemoryRequest(BaseModel):
model_config = ConfigDict(title='UpdateMemoryRequest')
content: Optional[str] = Field(default=None, description="New content for the memory", min_length=1, max_length=500)
visibility: Optional[str] = Field(default=None, description="New visibility: public or private")
tags: Optional[List[str]] = Field(default=None, description="New tags for the memory")
category: Optional[MemoryCategory] = Field(default=None, description="New category for the memory")
class BatchMemoriesRequest(BaseModel):
model_config = ConfigDict(title='BatchMemoriesRequest')
memories: List[CreateMemoryRequest] = Field(description="List of memories to create", max_length=25)
class BatchMemoriesResponse(BaseModel):
model_config = ConfigDict(title='BatchMemoriesResponse')
memories: List[DeveloperMemory]
created_count: int
@router.get(
"/v1/dev/user/memories",
tags=["Memories"],
response_model=List[DeveloperMemory],
operation_id="listMemories",
)
def get_memories(
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_read_context),
limit: int = 25,
offset: int = 0,
categories: Optional[str] = None,
):
uid = auth_context.uid
# Clamp pagination so a negative value cannot reach Firestore (which raises -> HTTP 500) and an
# oversized limit cannot stream the whole collection. Mirrors the GET /v3/memories hardening.
offset = max(0, offset)
limit = max(1, min(limit, 1000))
category_list = []
if categories:
try:
category_list = [MemoryCategory(c.strip()) for c in categories.split(",") if c.strip()]
except ValueError as e:
raise HTTPException(status_code=400, detail=f"Invalid category {str(e)}")
app_key_grant = authorize_memory_external_default_memory_read(auth_context, db_client=db)
if not app_key_grant.allowed:
raise HTTPException(
status_code=app_key_grant.status_code,
detail={
"enabled": False,
"reason": app_key_grant.reason,
"consumer": "developer_api",
"archive_default_visible": False,
"archive_capability": False,
"app_id": auth_context.app_id,
"key_id": auth_context.key_id,
},
)
service = MemoryService(db_client=db)
allowed = {category.value for category in category_list} if category_list else None
if allowed is None:
memories = service.read(uid, limit=limit, offset=offset, include_pending_processing=True)
valid_memories = []
for memory in memories:
try:
valid_memories.append(CleanerMemory.model_validate(memory.model_dump(mode="json")))
except (AttributeError, TypeError, ValidationError, ValueError):
logger.warning("Skipping malformed memory in Developer API list")
return valid_memories
# Category is a sparse filter. Read ordered universal pages until the
# requested category page is filled instead of filtering after a raw page
# (which returned short/empty pages whenever non-matching memories led it).
target_end = offset + limit
scan_offset = 0
matched = []
max_scan = 5000
while scan_offset < max_scan and len(matched) < target_end:
batch_limit = min(500, max_scan - scan_offset)
batch = service.read(uid, limit=batch_limit, offset=scan_offset, include_pending_processing=True)
if not batch:
break
scan_offset += len(batch)
if allowed is None:
matched.extend(batch)
else:
matched.extend(memory for memory in batch if getattr(memory.category, "value", memory.category) in allowed)
if len(batch) < batch_limit:
break
memories = matched[offset:target_end]
valid_memories = []
for memory in memories:
try:
valid_memories.append(CleanerMemory.model_validate(memory.model_dump(mode="json")))
except (AttributeError, TypeError, ValidationError, ValueError):
# MemoryService normally returns validated MemoryDB rows, but a
# malformed historical adapter row must not turn this compatibility
# endpoint into a 500 for every otherwise healthy memory.
logger.warning("Skipping malformed memory in Developer API list")
return valid_memories
@router.get(
"/v1/dev/user/memories/vector/search",
tags=["developer"],
response_model=DeveloperMemoryVectorSearchResponse,
)
def search_memories_vector(
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_read_context),
query: str = Query(..., min_length=1),
limit: int = Query(10, ge=1, le=100),
):
"""Search developer-readable default memory memory through hydrated vector candidates.
This narrow developer API vector endpoint fails closed unless the authenticated
Developer API app/key has a verified memories.read scope and a persisted app/key
default-read grant. Vector hits are hydrated through the universal repository
against authoritative
`users/{uid}/memory_items` before returning results, so stale Short-term and
Archive remain unavailable by default.
"""
uid = auth_context.uid
app_key_grant = authorize_memory_external_default_memory_read(auth_context, db_client=db)
if not app_key_grant.allowed:
raise HTTPException(
status_code=app_key_grant.status_code,
detail={
'enabled': False,
'reason': app_key_grant.reason,
'consumer': 'developer_api',
'archive_default_visible': False,
'archive_capability': False,
'app_id': auth_context.app_id,
'key_id': auth_context.key_id,
},
)
matches = MemoryService(db_client=db).search(uid, query, limit=min(limit, 20))
items = [
{
'id': match.memory.id,
'content': match.memory.content,
'category': (
match.memory.category.value if hasattr(match.memory.category, 'value') else match.memory.category
),
'relevance_score': round(match.score, 4),
}
for match in matches
]
return {
'items': items,
'returned_count': len(items),
'archive_default_visible': False,
'policy': {
'consumer': 'developer_api',
'app_has_default_memory_grant': True,
'archive_capability': False,
'raw_provenance_capability': False,
},
}
@router.post("/v1/dev/user/memories", response_model=DeveloperMemory, tags=["Memories"], operation_id="createMemory")
def create_memory(
request: CreateMemoryRequest,
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_write_context),
):
"""
Create a new memory for the authenticated user.
- **content**: The content of the memory (1-500 characters)
- **category**: Memory category (auto-categorized if not provided)
- **visibility**: Visibility: public or private (default: private)
- **tags**: List of tags associated with the memory
"""
if not request.content or len(request.content.strip()) == 0:
raise HTTPException(status_code=422, detail="content cannot be empty")
# Fail closed: a legacy/read-only Developer key (no persisted memories.write
# grant) must not mutate canonical memories. The canonical branch skips the
# legacy write guard inside create_external_memory(), so the grant check must
# run first for both canonical and legacy paths.
write_grant = authorize_memory_external_default_memory_write(auth_context, db_client=db)
if not write_grant.allowed:
raise HTTPException(
status_code=write_grant.status_code,
detail=write_grant.observability,
)
uid = auth_context.uid
category = request.category if request.category else identify_category_for_memory(request.content.strip())
memory = Memory(
content=request.content.strip(),
category=category,
visibility=request.visibility,
tags=request.tags,
)
memory_db = MemoryDB.from_memory(memory, uid, None, True)
memory_db = MemoryService(db_client=db).create_external_memory(
uid,
memory_db,
memory_system=MemorySystem.CANONICAL,
consumer='developer_api',
operation='create_memory',
upsert_vector=False,
require_canonical_promotion=True,
)
capture_memory_write(
principal_id=uid,
source="developer_memory_create",
session_id=memory_db.id,
memories=[memory_db],
)
if memory.visibility == 'public':
postprocess_executor.submit(update_personas_async, uid)
return DeveloperMemory(
id=memory_db.id,
content=memory_db.content,
category=memory_db.category,
visibility=memory_db.visibility,
tags=memory_db.tags,
created_at=memory_db.created_at,
updated_at=memory_db.updated_at,
manually_added=memory_db.manually_added,
)
@router.post(
"/v1/dev/user/memories/batch",
response_model=BatchMemoriesResponse,
tags=["Memories"],
operation_id="createMemoriesBatch",
)
def create_memories_batch(
request: BatchMemoriesRequest,
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_batch_write_context),
):
"""
Create multiple memories in a batch.
- **memories**: List of memories to create (max 25)
"""
# Fail closed: a legacy/read-only Developer key (no persisted memories.write
# grant) must not mutate canonical memories. Gated before any memory
# construction so rejected requests build no side effects.
write_grant = authorize_memory_external_default_memory_write(auth_context, db_client=db)
if not write_grant.allowed:
raise HTTPException(
status_code=write_grant.status_code,
detail=write_grant.observability,
)
uid = auth_context.uid
if not request.memories:
return BatchMemoriesResponse(memories=[], created_count=0)
if len(request.memories) > 25:
raise HTTPException(status_code=422, detail="Maximum 25 memories per batch request")
memory_dbs = []
has_public = False
for mem_req in request.memories:
if not mem_req.content or len(mem_req.content.strip()) == 0:
raise HTTPException(status_code=422, detail="All memories must have non-empty content")
category = mem_req.category if mem_req.category else identify_category_for_memory(mem_req.content.strip())
memory = Memory(
content=mem_req.content.strip(),
category=category,
visibility=mem_req.visibility,
tags=mem_req.tags,
)
memory_db = MemoryDB.from_memory(memory, uid, None, True)
memory_dbs.append(memory_db)
if memory.visibility == 'public':
has_public = True
created_dbs = MemoryService(db_client=db).create_external_memory_batch(
uid,
memory_dbs,
memory_system=MemorySystem.CANONICAL,
consumer='developer_api',
operation='batch_create_memories',
upsert_vectors=False,
require_canonical_promotion=True,
)
capture_memory_write(
principal_id=uid,
source="developer_memory_batch_create",
session_id=str(uuid.uuid4()),
memories=created_dbs,
)
if has_public:
postprocess_executor.submit(update_personas_async, uid)
created_memories = [
DeveloperMemory(
id=mem.id,
content=mem.content,
category=mem.category,
visibility=mem.visibility,
tags=mem.tags,
created_at=mem.created_at,
updated_at=mem.updated_at,
manually_added=mem.manually_added,
)
for mem in created_dbs
]
return BatchMemoriesResponse(memories=created_memories, created_count=len(created_memories))
@router.delete(
"/v1/dev/user/memories/{memory_id}",
tags=["Memories"],
operation_id="deleteMemory",
response_model=DeveloperSuccessResponse,
)
def delete_memory(
memory_id: str,
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_write_context),
):
"""
Delete a memory by ID.
- **memory_id**: The ID of the memory to delete
"""
# Fail closed: a legacy/read-only Developer key (no persisted memories.write
# grant) must not mutate canonical memories.
write_grant = authorize_memory_external_default_memory_write(auth_context, db_client=db)
if not write_grant.allowed:
raise HTTPException(
status_code=write_grant.status_code,
detail=write_grant.observability,
)
uid = auth_context.uid
MemoryService(db_client=db).delete_external_memory(
uid,
memory_id,
memory_system=MemorySystem.CANONICAL,
consumer='developer_api',
operation='delete_memory',
delete_vector=False,
)
return {"success": True}
@router.patch(
"/v1/dev/user/memories/{memory_id}",
response_model=DeveloperMemory,
tags=["Memories"],
operation_id="updateMemory",
)
def update_memory(
memory_id: str,
request: UpdateMemoryRequest,
auth_context: ProductAuthorizationContext = Depends(get_developer_memory_default_memory_write_context),
):
"""
Update a memory's content, visibility, tags, or category.
- **memory_id**: The ID of the memory to update
- **content**: New content for the memory (optional)
- **visibility**: New visibility: public or private (optional)
- **tags**: New tags for the memory (optional)
- **category**: New category for the memory (optional)
"""
# Fail closed: a legacy/read-only Developer key (no persisted memories.write
# grant) must not mutate canonical memories.
write_grant = authorize_memory_external_default_memory_write(auth_context, db_client=db)
if not write_grant.allowed:
raise HTTPException(
status_code=write_grant.status_code,
detail=write_grant.observability,
)
uid = auth_context.uid
if request.content is None and request.visibility is None and request.tags is None and request.category is None:
raise HTTPException(
status_code=422, detail="At least one field (content, visibility, tags, or category) must be provided"
)
memory_service = MemoryService(db_client=db)
if request.content is not None:
if not request.content.strip():
raise HTTPException(status_code=422, detail="content must not be empty")
memory_service.update_content(uid, memory_id, request.content.strip())
if request.visibility is not None:
if request.visibility not in ['public', 'private']:
raise HTTPException(status_code=422, detail="visibility must be 'public' or 'private'")
memory_service.update_visibility(uid, memory_id, request.visibility)
if request.tags is not None or request.category is not None:
memory_service.update_product_fields(
uid,
memory_id,
tags=request.tags,
category=request.category.value if request.category is not None else None,
)
try:
return fetch_memory_dict(uid, memory_id, db_client=db)
except HTTPException:
raise
except (KeyError, ValueError):
raise HTTPException(status_code=404, detail="Memory not found")
# ******************************************************
# ******************* ACTION ITEMS *********************
# ******************************************************
class ActionItemResponse(BaseModel):
model_config = ConfigDict(title='DeveloperActionItem')
id: str
description: str
completed: bool
created_at: Optional[datetime] = None
updated_at: Optional[datetime] = None
due_at: Optional[datetime] = None
completed_at: Optional[datetime] = None
conversation_id: Optional[str] = None
class CreateActionItemRequest(BaseModel):
model_config = ConfigDict(title='CreateActionItemRequest')
description: str = Field(description="The action item description", min_length=1, max_length=500)
completed: bool = Field(default=False, description="Whether the action item is completed")
due_at: Optional[datetime] = Field(
default=None, description="When the action item is due (ISO format with timezone)"
)
class UpdateActionItemRequest(BaseModel):
model_config = ConfigDict(title='UpdateActionItemRequest')
description: Optional[str] = Field(default=None, description="New description", min_length=1, max_length=500)
completed: Optional[bool] = Field(default=None, description="New completion status")
due_at: Optional[datetime] = Field(default=None, description="New due date (ISO format with timezone)")
class BatchActionItemsRequest(BaseModel):
model_config = ConfigDict(title='BatchActionItemsRequest')
action_items: List[CreateActionItemRequest] = Field(description="List of action items to create", max_length=50)
class BatchActionItemsResponse(BaseModel):
model_config = ConfigDict(title='BatchActionItemsResponse')
action_items: List[ActionItemResponse]
created_count: int
@router.get(
"/v1/dev/user/action-items",
tags=["Action Items"],
response_model=List[ActionItemResponse],
operation_id="listActionItems",
)
def get_action_items(
uid: str = Depends(get_uid_with_action_items_read),
conversation_id: Optional[str] = None,
completed: Optional[bool] = None,
start_date: Optional[datetime] = None,
end_date: Optional[datetime] = None,
limit: int = 100,
offset: int = 0,
):
"""
Get action items with optional filters. Locked action items are excluded.
- **conversation_id**: Filter by conversation ID (None for standalone items)
- **completed**: Filter by completion status
- **start_date**: Filter by start date (inclusive)
- **end_date**: Filter by end date (inclusive)
- **limit**: Maximum number of items to return
- **offset**: Number of items to skip
"""
# Clamp pagination so a negative value cannot reach Firestore (which raises -> HTTP 500) and an
# oversized limit cannot stream the whole collection. Mirrors the GET /v3/memories hardening.
offset = max(0, offset)
limit = max(1, min(limit, 1000))
action_items = action_items_db.get_action_items(
uid=uid,
conversation_id=conversation_id,
completed=completed,
start_date=start_date,
end_date=end_date,
limit=limit,
offset=offset,
)
# Validate each record individually so a single malformed/legacy doc (e.g. missing a required
# field like description/completed) doesn't fail the whole page with a 500. Mirrors the hardening
# already applied to GET /v1/dev/user/memories.
valid_action_items = []
for item in action_items:
if not isinstance(item, dict) or not item.get('id'):
logger.warning('Skipping malformed action item in Developer API action-item list')
continue
if item.get('is_locked', False):
continue
try:
valid_action_items.append(ActionItemResponse.model_validate(item))
except ValidationError as e:
invalid_fields = [err['loc'][0] for err in e.errors() if err.get('loc')]
logger.warning(
f"Skipping invalid action item doc {item.get('id', 'unknown')} for uid {uid}: "
f"missing/invalid fields {invalid_fields}"
)
continue
return valid_action_items
@router.post(
"/v1/dev/user/action-items",
response_model=ActionItemResponse,
tags=["Action Items"],
operation_id="createActionItem",
)
def create_action_item(
request: CreateActionItemRequest,
uid: str = Depends(get_uid_with_action_items_write),
):
"""
Create a new action item for the authenticated user.
- **description**: The action item description (1-500 characters)
- **completed**: Whether the action item is completed (default: False)
- **due_at**: Optional due date in ISO 8601 format with timezone
"""
if not request.description or len(request.description.strip()) == 0:
raise HTTPException(status_code=422, detail="description cannot be empty")
action_item_data = {
'description': request.description.strip(),
'completed': request.completed,
'due_at': request.due_at,
'conversation_id': None,
}
action_item_id = action_items_db.create_action_item(uid, action_item_data)
action_item = action_items_db.get_action_item(uid, action_item_id)
if not action_item:
raise HTTPException(status_code=500, detail="Failed to create action item")
# Send FCM data message if action item has a due date
if request.due_at:
send_action_item_data_message(
user_id=uid,
action_item_id=action_item_id,
description=request.description.strip(),
due_at=request.due_at.isoformat(),
)
return ActionItemResponse(**action_item)
@router.post(
"/v1/dev/user/action-items/batch",
response_model=BatchActionItemsResponse,
tags=["Action Items"],
operation_id="createActionItemsBatch",
)
def create_action_items_batch(
request: BatchActionItemsRequest,
uid: str = Depends(get_uid_with_action_items_write),
):
"""
Create multiple action items in a batch.
- **action_items**: List of action items to create (max 50)
"""
if not request.action_items:
return BatchActionItemsResponse(action_items=[], created_count=0)
if len(request.action_items) > 50:
raise HTTPException(status_code=422, detail="Maximum 50 action items per batch request")
# Prepare action items data
action_items_data = []
for item in request.action_items:
if not item.description or len(item.description.strip()) == 0:
raise HTTPException(status_code=422, detail="All action items must have non-empty descriptions")
action_item_data = {
'description': item.description.strip(),
'completed': item.completed,
'due_at': item.due_at,
'conversation_id': None,
}
action_items_data.append(action_item_data)
# Create batch
created_ids = action_items_db.create_action_items_batch(uid, action_items_data)
# Fetch all created items in a single batch query
created_items_list = action_items_db.get_action_items_by_ids(uid, created_ids)
# Send FCM messages for items with due dates
for idx, item in enumerate(created_items_list):
if idx < len(request.action_items) and request.action_items[idx].due_at:
send_action_item_data_message(
user_id=uid,
action_item_id=item['id'],
description=request.action_items[idx].description.strip(),
due_at=request.action_items[idx].due_at.isoformat(),
)
# Convert to response objects
created_items = [ActionItemResponse(**item) for item in created_items_list]
return BatchActionItemsResponse(action_items=created_items, created_count=len(created_items))
@router.delete(
"/v1/dev/user/action-items/{action_item_id}",
tags=["Action Items"],
operation_id="deleteActionItem",
response_model=DeveloperSuccessResponse,
)
def delete_action_item(
action_item_id: str,
uid: str = Depends(get_uid_with_action_items_write),
):
"""
Delete an action item by ID.
- **action_item_id**: The ID of the action item to delete
"""
action_item = action_items_db.get_action_item(uid, action_item_id)
if not action_item:
raise HTTPException(status_code=404, detail="Action item not found")
if action_item.get('is_locked', False):
raise HTTPException(status_code=402, detail="A paid plan is required to access this action item.")
action_items_db.delete_action_item(uid, action_item_id)
return {"success": True}
@router.patch(
"/v1/dev/user/action-items/{action_item_id}",
response_model=ActionItemResponse,
tags=["Action Items"],
operation_id="updateActionItem",
)
def update_action_item(
action_item_id: str,
request: UpdateActionItemRequest,
uid: str = Depends(get_uid_with_action_items_write),
):
"""
Update an action item.
- **action_item_id**: The ID of the action item to update
- **description**: New description (optional)
- **completed**: New completion status (optional)
- **due_at**: New due date (optional, set to null to remove)
"""
# Check if action item exists
action_item = action_items_db.get_action_item(uid, action_item_id)
if not action_item:
raise HTTPException(status_code=404, detail="Action item not found")
if action_item.get('is_locked', False):
raise HTTPException(status_code=402, detail="A paid plan is required to access this action item.")
# Build update data from explicitly provided fields so due_at=null can clear the date.
update_data = {}
if request.description is not None:
update_data['description'] = request.description.strip()
if request.completed is not None:
update_data['completed'] = request.completed
# Set or clear completed_at based on completion status
if request.completed:
update_data['completed_at'] = datetime.now(timezone.utc)
else:
update_data['completed_at'] = None
if 'due_at' in request.model_fields_set: