v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB

blocks

Modify Block

patch/v1/blocks/{block_id}

Path parameters

block_idstring required

Request body

valuestring nullable

Value of the block.

limitinteger nullable

Character limit of the block.

project_idstring nullable

The associated project id.

namestring nullable

The id of the template.

is_templateboolean

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

base_template_idstring nullable

The base template id of the block.

deployment_idstring nullable

The id of the deployment.

entity_idstring nullable

The id of the entity within the template.

preserve_on_migrationboolean nullable

Preserve the block on template migration.

labelstring nullable

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

read_onlyboolean

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

descriptionstring nullable

Description of the block.

metadataobject nullable

Metadata of the block.

hiddenboolean nullable

If set to True, the block will be hidden.

Response

Successful Response

valuestring required