Create Identity

identities.create() -> Identity

post/v1/identities/

Create Identity

ParametersExpand Collapse

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.

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.

project_id: Optional[str]

The project id of the identity, if applicable.

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]

Create Identity

from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
identity = client.identities.create(
    identifier_key="identifier_key",
    identity_type="org",
    name="name",
)
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"
    }
  ]
}