Sign in

v36

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

Retrieve Block

Retrieve a core memory block from an agent.

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

Path parameters

agent_idstring required
block_labelstring required

Response

Successful Response

valuestring required

Value of the block.

limitinteger

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.

idstring

The human-friendly ID of the Block

created_by_idstring nullable

The id of the user that made this Block.

last_updated_by_idstring nullable

The id of the user that last updated this Block.

Example response

{
  "id": "block-123e4567-e89b-12d3-a456-426614174000"
}