Retrieve Block

Authentication

AuthorizationBearer

Header authentication of the form `Bearer <token>`

Path Parameters

block_idstringRequiredformat: "^block-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=42 characters

The ID of the block in the format 'block-<uuid4>'

Response

Successful Response

valuestring

Value of the block.

idstring

The id of the block.

limitinteger or nullDefaults to 20000

Character limit of the block.

project_idstring or null

The associated project id.

is_templateboolean or nullDefaults to false

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

labelstring or null

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

descriptionstring or null

Description of the block.

metadatamap from strings to any or null

Metadata of the block.

created_by_idstring or null

The id of the user that made this Block.

last_updated_by_idstring or null

The id of the user that last updated this Block.

template_namestring or nullDeprecated

(Deprecated) The name of the block template (if it is a template).

template_idstring or nullDeprecated

(Deprecated) The id of the template.

base_template_idstring or nullDeprecated

(Deprecated) The base template id of the block.

deployment_idstring or nullDeprecated

(Deprecated) The id of the deployment.

entity_idstring or nullDeprecated

(Deprecated) The id of the entity within the template.

preserve_on_migrationboolean or nullDefaults to falseDeprecated

(Deprecated) Preserve the block on template migration.

read_onlyboolean or nullDefaults to falseDeprecated

(Deprecated) Whether the agent has read-only access to the block.

hiddenboolean or nullDeprecated

(Deprecated) If set to True, the block will be hidden.

1	{
2	"value": "string",
3	"id": "string",
4	"limit": 20000,
5	"project_id": "string",
6	"is_template": false,
7	"label": "string",
8	"description": "string",
9	"metadata": {},
10	"created_by_id": "string",
11	"last_updated_by_id": "string",
12	"template_name": "string",
13	"template_id": "string",
14	"base_template_id": "string",
15	"deployment_id": "string",
16	"entity_id": "string",
17	"preserve_on_migration": true,
18	"read_only": false,
19	"hidden": true
20	}

1	import { LettaClient } from "@letta-ai/letta-client";
2
3	const client = new LettaClient({ token: "YOUR_TOKEN", project: "YOUR_PROJECT" });
4	await client.blocks.retrieve("block-123e4567-e89b-42d3-8456-426614174000");

Authentication

Path Parameters

Response

Errors