Blocks

Retrieve Block For Agent

client.agents.blocks.retrieve(, , ?): BlockResponse { id, value, base_template_id, 15 more }

get/v1/agents/{agent_id}/core-memory/blocks/{block_label}

Modify Block For Agent

client.agents.blocks.modify(, , ?): BlockResponse { id, value, base_template_id, 15 more }

patch/v1/agents/{agent_id}/core-memory/blocks/{block_label}

List Blocks For Agent

client.agents.blocks.list(, ?, ?): ArrayPage<BlockResponse { id, value, base_template_id, 15 more } >

get/v1/agents/{agent_id}/core-memory/blocks

Attach Block To Agent

client.agents.blocks.attach(, , ?): AgentState { id, agent_type, blocks, 39 more }

patch/v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}

Detach Block From Agent

client.agents.blocks.detach(, , ?): AgentState { id, agent_type, blocks, 39 more }

patch/v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}

ModelsExpand Collapse

Block { value, id, base_template_id, 15 more }

A Block represents a reserved section of the LLM's context window.

value: string

Value of the block.

id?: string

The human-friendly ID of the Block

base_template_id?: string | null

The base template id of the block.

created_by_id?: string | null

The id of the user that made this Block.

deployment_id?: string | null

The id of the deployment.

description?: string | null

Description of the block.

entity_id?: string | null

The id of the entity within the template.

hidden?: boolean | null

If set to True, the block will be hidden.

is_template?: boolean

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.

last_updated_by_id?: string | null

The id of the user that last updated this Block.

limit?: number

Character limit of the block.

metadata?: Record<string, unknown> | null

Metadata of the block.

preserve_on_migration?: boolean | null

Preserve the block on template migration.

project_id?: string | null

The associated project id.

read_only?: boolean

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

template_id?: string | null

The id of the template.

template_name?: string | null

Name of the block if it is a template.

BlockModify { base_template_id, deployment_id, description, 12 more }

Update a block