Skip to content
  • Auto
  • Light
  • Dark
DiscordForumGitHubSign up
View as Markdown
Copy Markdown

Open in Claude
Open in ChatGPT

Blocks

Retrieve Block For Agent
get/v1/agents/{agent_id}/core-memory/blocks/{block_label}
Modify Block For Agent
patch/v1/agents/{agent_id}/core-memory/blocks/{block_label}
List Blocks For Agent
get/v1/agents/{agent_id}/core-memory/blocks
Attach Block To Agent
patch/v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}
Detach Block From Agent
patch/v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}
ModelsExpand Collapse
Block = object { 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: optional string

The human-friendly ID of the Block

base_template_id: optional string

The base template id of the block.

created_by_id: optional string

The id of the user that made this Block.

deployment_id: optional string

The id of the deployment.

description: optional string

Description of the block.

entity_id: optional string

The id of the entity within the template.

hidden: optional boolean

If set to True, the block will be hidden.

is_template: optional boolean

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

label: optional string

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

last_updated_by_id: optional string

The id of the user that last updated this Block.

limit: optional number

Character limit of the block.

metadata: optional map[unknown]

Metadata of the block.

preserve_on_migration: optional boolean

Preserve the block on template migration.

project_id: optional string

The associated project id.

read_only: optional boolean

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

template_id: optional string

The id of the template.

template_name: optional string

Name of the block if it is a template.

BlockModify = object { base_template_id, deployment_id, description, 12 more }

Update a block

base_template_id: optional string

The base template id of the block.

deployment_id: optional string

The id of the deployment.

description: optional string

Description of the block.

entity_id: optional string

The id of the entity within the template.

hidden: optional boolean

If set to True, the block will be hidden.

is_template: optional boolean

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

label: optional string

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

limit: optional number

Character limit of the block.

metadata: optional map[unknown]

Metadata of the block.

preserve_on_migration: optional boolean

Preserve the block on template migration.

project_id: optional string

The associated project id.

read_only: optional boolean

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

template_id: optional string

The id of the template.

template_name: optional string

Name of the block if it is a template.

value: optional string

Value of the block.