PATCH
/
v1
/
blocks
/
{block_id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

block_id
string
required

Body

application/json

Update a block

value
string | null

Value of the block.

limit
integer | null
default: 2000

Character limit of the block.

name
string | null

Name of the block if it is a template.

is_template
boolean
default: false

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

label
string | null

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

description
string | null

Description of the block.

metadata_
object | null

Metadata of the block.

Response

200 - application/json

A Block represents a reserved section of the LLM's context window which is editable. Block objects contained in the Memory object, which is able to edit the Block values.

Parameters: label (str): The label of the block (e.g. 'human', 'persona'). This defines a category for the block. value (str): The value of the block. This is the string that is represented in the context window. limit (int): The character limit of the block. is_template (bool): Whether the block is a template (e.g. saved human/persona options). Non-template blocks are not stored in the database and are ephemeral, while templated blocks are stored in the database. label (str): The label of the block (e.g. 'human', 'persona'). This defines a category for the block. template_name (str): The name of the block template (if it is a template). description (str): Description of the block. metadata_ (Dict): Metadata of the block. user_id (str): The unique identifier of the user associated with the block.

value
string
required

Value of the block.

limit
integer
default: 2000

Character limit of the block.

name
string | null

Name of the block if it is a template.

is_template
boolean
default: false

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

label
string | null

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

description
string | null

Description of the block.

metadata_
object | null

Metadata of the block.

id
string

The human-friendly ID of the Block

organization_id
string | null

The unique identifier of the organization associated with the block.

created_by_id
string | null

The id of the user that made this Block.

last_updated_by_id
string | null

The id of the user that last updated this Block.