Files
letta-server/letta/server/rest_api/routers/v1/identities.py
Kian Jones f5c4ab50f4 chore: add ty + pre-commit hook and repeal even more ruff rules (#9504)
* auto fixes

* auto fix pt2 and transitive deps and undefined var checking locals()

* manual fixes (ignored or letta-code fixed)

* fix circular import

* remove all ignores, add FastAPI rules and Ruff rules

* add ty and precommit

* ruff stuff

* ty check fixes

* ty check fixes pt 2

* error on invalid
2026-02-24 10:55:11 -08:00

226 lines
9.4 KiB
Python

from typing import TYPE_CHECKING, List, Literal, Optional
from fastapi import APIRouter, Body, Depends, Header, Query
from letta.orm.errors import NoResultFound
from letta.schemas.agent import AgentRelationships, AgentState
from letta.schemas.block import BlockResponse
from letta.schemas.identity import (
Identity,
IdentityCreate,
IdentityProperty,
IdentityType,
IdentityUpdate,
IdentityUpsert,
)
from letta.server.rest_api.dependencies import HeaderParams, get_headers, get_letta_server
from letta.validators import IdentityId
if TYPE_CHECKING:
from letta.server.server import SyncServer
router = APIRouter(prefix="/identities", tags=["identities"])
@router.get("/", tags=["identities"], response_model=List[Identity], operation_id="list_identities", deprecated=True)
async def list_identities(
name: Optional[str] = Query(None),
project_id: Optional[str] = Query(
None,
deprecated=True,
description="[DEPRECATED: Use X-Project-Id header instead] Filter identities by project ID",
),
identifier_key: Optional[str] = Query(None),
identity_type: Optional[IdentityType] = Query(None),
before: Optional[str] = Query(
None,
description="Identity ID cursor for pagination. Returns identities that come before this identity ID in the specified sort order",
),
after: Optional[str] = Query(
None,
description="Identity ID cursor for pagination. Returns identities that come after this identity ID in the specified sort order",
),
limit: Optional[int] = Query(50, description="Maximum number of identities to return"),
order: Literal["asc", "desc"] = Query(
"desc", description="Sort order for identities by creation time. 'asc' for oldest first, 'desc' for newest first"
),
order_by: Literal["created_at"] = Query("created_at", description="Field to sort by"),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
"""
Get a list of all identities in the database
"""
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
identities, _next_cursor, _has_more = await server.identity_manager.list_identities_async(
name=name,
project_id=project_id,
identifier_key=identifier_key,
identity_type=identity_type,
before=before,
after=after,
limit=limit,
ascending=(order == "asc"),
actor=actor,
)
return identities
@router.get("/count", tags=["identities"], response_model=int, operation_id="count_identities", deprecated=True)
async def count_identities(
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
"""
Get count of all identities for a user
"""
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
try:
return await server.identity_manager.size_async(actor=actor)
except NoResultFound:
return 0
@router.get("/{identity_id}", tags=["identities"], response_model=Identity, operation_id="retrieve_identity", deprecated=True)
async def retrieve_identity(
identity_id: IdentityId,
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.get_identity_async(identity_id=identity_id, actor=actor)
@router.post("/", tags=["identities"], response_model=Identity, operation_id="create_identity", deprecated=True)
async def create_identity(
identity: IdentityCreate = Body(...),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
x_project: Optional[str] = Header(
None, alias="X-Project", description="The project slug to associate with the identity (cloud only)."
), # Only handled by next js middleware
):
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.create_identity_async(identity=identity, actor=actor)
@router.put("/", tags=["identities"], response_model=Identity, operation_id="upsert_identity", deprecated=True)
async def upsert_identity(
identity: IdentityUpsert = Body(...),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
x_project: Optional[str] = Header(
None, alias="X-Project", description="The project slug to associate with the identity (cloud only)."
), # Only handled by next js middleware
):
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.upsert_identity_async(identity=identity, actor=actor)
@router.patch("/{identity_id}", tags=["identities"], response_model=Identity, operation_id="update_identity", deprecated=True)
async def modify_identity(
identity_id: IdentityId,
identity: IdentityUpdate = Body(...),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.update_identity_async(identity_id=identity_id, identity=identity, actor=actor)
@router.put("/{identity_id}/properties", tags=["identities"], operation_id="upsert_properties_for_identity", deprecated=True)
async def upsert_properties_for_identity(
identity_id: IdentityId,
properties: List[IdentityProperty] = Body(...),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.upsert_identity_properties_async(identity_id=identity_id, properties=properties, actor=actor)
@router.delete("/{identity_id}", tags=["identities"], operation_id="delete_identity", deprecated=True)
async def delete_identity(
identity_id: IdentityId,
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
"""
Delete an identity by its identifier key
"""
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
await server.identity_manager.delete_identity_async(identity_id=identity_id, actor=actor)
@router.get("/{identity_id}/agents", response_model=List[AgentState], operation_id="list_agents_for_identity", deprecated=True)
async def list_agents_for_identity(
identity_id: IdentityId,
before: Optional[str] = Query(
None,
description="Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order",
),
after: Optional[str] = Query(
None,
description="Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order",
),
limit: Optional[int] = Query(50, description="Maximum number of agents to return"),
order: Literal["asc", "desc"] = Query(
"desc", description="Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first"
),
order_by: Literal["created_at"] = Query("created_at", description="Field to sort by"),
include: List[AgentRelationships] = Query(
[],
description=("Specify which relational fields to include in the response. No relationships are included by default."),
),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
"""
Get all agents associated with the specified identity.
"""
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.list_agents_for_identity_async(
identity_id=identity_id,
before=before,
after=after,
limit=limit,
ascending=(order == "asc"),
include=include,
actor=actor,
)
@router.get("/{identity_id}/blocks", response_model=List[BlockResponse], operation_id="list_blocks_for_identity", deprecated=True)
async def list_blocks_for_identity(
identity_id: IdentityId,
before: Optional[str] = Query(
None,
description="Block ID cursor for pagination. Returns blocks that come before this block ID in the specified sort order",
),
after: Optional[str] = Query(
None,
description="Block ID cursor for pagination. Returns blocks that come after this block ID in the specified sort order",
),
limit: Optional[int] = Query(50, description="Maximum number of blocks to return"),
order: Literal["asc", "desc"] = Query(
"desc", description="Sort order for blocks by creation time. 'asc' for oldest first, 'desc' for newest first"
),
order_by: Literal["created_at"] = Query("created_at", description="Field to sort by"),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
"""
Get all blocks associated with the specified identity.
"""
actor = await server.user_manager.get_actor_or_default_async(actor_id=headers.actor_id)
return await server.identity_manager.list_blocks_for_identity_async(
identity_id=identity_id,
before=before,
after=after,
limit=limit,
ascending=(order == "asc"),
actor=actor,
)