Skip to content
My Docs My Docs letta-sdk
  • Auto
  • Light
  • Dark
DiscordForumGitHubSign up
API Reference
Identities
View as Markdown
Copy Markdown
Open in Claude
Open in ChatGPT

Modify Identity

identities.modify(stridentity_id, IdentityModifyParams**kwargs) -> Identity
patch/v1/identities/{identity_id}

Modify Identity

ParametersExpand Collapse
identity_id: str

The ID of the identity in the format 'identity-'

minLength45
maxLength45
Deprecatedagent_ids: Optional[SequenceNotStr[str]]

The agent ids that are associated with the identity.

Deprecatedblock_ids: Optional[SequenceNotStr[str]]

The IDs of the blocks associated with the identity.

identifier_key: Optional[str]

External, user-generated identifier key of the identity.

identity_type: Optional[IdentityType]

Enum to represent the type of the identity.

Accepts one of the following:
"org"
"user"
"other"
name: Optional[str]

The name of the identity.

properties: Optional[Iterable[IdentityPropertyParam]]

List of properties associated with the identity.

key: str

The key of the property

type: Literal["string", "number", "boolean", "json"]

The type of the property

Accepts one of the following:
"string"
"number"
"boolean"
"json"
value: Union[str, float, bool, Dict[str, object]]

The value of the property

Accepts one of the following:
ValueUnionMember0 = str
ValueUnionMember1 = float
ValueUnionMember2 = bool
ValueUnionMember3 = Dict[str, object]
ReturnsExpand Collapse
class Identity: …
id: str

The human-friendly ID of the Identity

Deprecatedagent_ids: List[str]

The IDs of the agents associated with the identity.

Deprecatedblock_ids: List[str]

The IDs of the blocks associated with the identity.

identifier_key: str

External, user-generated identifier key of the identity.

identity_type: IdentityType

The type of the identity.

Accepts one of the following:
"org"
"user"
"other"
name: str

The name of the identity.

project_id: Optional[str]

The project id of the identity, if applicable.

properties: Optional[List[IdentityProperty]]

List of properties associated with the identity

key: str

The key of the property

type: Literal["string", "number", "boolean", "json"]

The type of the property

Accepts one of the following:
"string"
"number"
"boolean"
"json"
value: Union[str, float, bool, Dict[str, object]]

The value of the property

Accepts one of the following:
ValueUnionMember0 = str
ValueUnionMember1 = float
ValueUnionMember2 = bool
ValueUnionMember3 = Dict[str, object]
Modify Identity
  • HTTP
  • TypeScript
  • Python
from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
identity = client.identities.modify(
    identity_id="identity-123e4567-e89b-42d3-8456-426614174000",
)
print(identity.id)
{
  "id": "identity-123e4567-e89b-12d3-a456-426614174000",
  "agent_ids": [
    "string"
  ],
  "block_ids": [
    "string"
  ],
  "identifier_key": "identifier_key",
  "identity_type": "org",
  "name": "name",
  "project_id": "project_id",
  "properties": [
    {
      "key": "key",
      "type": "string",
      "value": "string"
    }
  ]
}
Returns Examples
{
  "id": "identity-123e4567-e89b-12d3-a456-426614174000",
  "agent_ids": [
    "string"
  ],
  "block_ids": [
    "string"
  ],
  "identifier_key": "identifier_key",
  "identity_type": "org",
  "name": "name",
  "project_id": "project_id",
  "properties": [
    {
      "key": "key",
      "type": "string",
      "value": "string"
    }
  ]
}