Modify Identity

client.identities.modify(, , ?): Identity { id, agent_ids, block_ids, 5 more }

patch/v1/identities/{identity_id}

Modify Identity

ParametersExpand Collapse

identityID: string

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

minLength45

maxLength45

body: IdentityModifyParams { agent_ids, block_ids, identifier_key, 3 more }

Deprecatedagent_ids?: Array<string> | null

The agent ids that are associated with the identity.

Deprecatedblock_ids?: Array<string> | null

The IDs of the blocks associated with the identity.

identifier_key?: string | null

External, user-generated identifier key of the identity.

identity_type?: IdentityType | null

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name?: string | null

The name of the identity.

properties?: Array<IdentityProperty { key, type, value } > | null

List of properties associated with the identity.

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

ReturnsExpand Collapse

Identity { id, agent_ids, block_ids, 5 more }

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: Array<string>

The IDs of the agents associated with the identity.

Deprecatedblock_ids: Array<string>

The IDs of the blocks associated with the identity.

identifier_key: string

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: string

The name of the identity.

project_id?: string | null

The project id of the identity, if applicable.

properties?: Array<IdentityProperty { key, type, value } >

List of properties associated with the identity

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

Modify Identity

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

const identity = await client.identities.modify('identity-123e4567-e89b-42d3-8456-426614174000');

console.log(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"
    }
  ]
}