Modify Block

blocks.modify(, ) -> BlockResponse

patch/v1/blocks/{block_id}

Modify Block

ParametersExpand Collapse

block_id: str

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

minLength42

maxLength42

base_template_id: Optional[str]

The base template id of the block.

deployment_id: Optional[str]

The id of the deployment.

description: Optional[str]

Description of the block.

entity_id: Optional[str]

The id of the entity within the template.

hidden: Optional[bool]

If set to True, the block will be hidden.

is_template: Optional[bool]

Whether the block is a template (e.g. saved human/persona options).

label: Optional[str]

Label of the block (e.g. 'human', 'persona') in the context window.

limit: Optional[int]

Character limit of the block.

metadata: Optional[Dict[str, object]]

Metadata of the block.

preserve_on_migration: Optional[bool]

Preserve the block on template migration.

project_id: Optional[str]

The associated project id.

read_only: Optional[bool]

Whether the agent has read-only access to the block.

template_id: Optional[str]

The id of the template.

template_name: Optional[str]

Name of the block if it is a template.

value: Optional[str]

Value of the block.

ReturnsExpand Collapse

class BlockResponse: …

id: str

The id of the block.

value: str

Value of the block.

Deprecatedbase_template_id: Optional[str]

(Deprecated) The base template id of the block.

created_by_id: Optional[str]

The id of the user that made this Block.

Deprecateddeployment_id: Optional[str]

(Deprecated) The id of the deployment.

description: Optional[str]

Description of the block.

Deprecatedentity_id: Optional[str]

(Deprecated) The id of the entity within the template.

Deprecatedhidden: Optional[bool]

(Deprecated) If set to True, the block will be hidden.

is_template: Optional[bool]

Whether the block is a template (e.g. saved human/persona options).

label: Optional[str]

Label of the block (e.g. 'human', 'persona') in the context window.

last_updated_by_id: Optional[str]

The id of the user that last updated this Block.

limit: Optional[int]

Character limit of the block.

metadata: Optional[Dict[str, object]]

Metadata of the block.

Deprecatedpreserve_on_migration: Optional[bool]

(Deprecated) Preserve the block on template migration.

project_id: Optional[str]

The associated project id.

Deprecatedread_only: Optional[bool]

(Deprecated) Whether the agent has read-only access to the block.

Deprecatedtemplate_id: Optional[str]

(Deprecated) The id of the template.

Deprecatedtemplate_name: Optional[str]

(Deprecated) The name of the block template (if it is a template).

Modify Block

from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
block_response = client.blocks.modify(
    block_id="block-123e4567-e89b-42d3-8456-426614174000",
)
print(block_response.id)

{
  "id": "id",
  "value": "value",
  "base_template_id": "base_template_id",
  "created_by_id": "created_by_id",
  "deployment_id": "deployment_id",
  "description": "description",
  "entity_id": "entity_id",
  "hidden": true,
  "is_template": true,
  "label": "label",
  "last_updated_by_id": "last_updated_by_id",
  "limit": 0,
  "metadata": {
    "foo": "bar"
  },
  "preserve_on_migration": true,
  "project_id": "project_id",
  "read_only": true,
  "template_id": "template_id",
  "template_name": "template_name"
}

Returns Examples

{
  "id": "id",
  "value": "value",
  "base_template_id": "base_template_id",
  "created_by_id": "created_by_id",
  "deployment_id": "deployment_id",
  "description": "description",
  "entity_id": "entity_id",
  "hidden": true,
  "is_template": true,
  "label": "label",
  "last_updated_by_id": "last_updated_by_id",
  "limit": 0,
  "metadata": {
    "foo": "bar"
  },
  "preserve_on_migration": true,
  "project_id": "project_id",
  "read_only": true,
  "template_id": "template_id",
  "template_name": "template_name"
}