List Blocks

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

get/v1/blocks/

List Blocks

ParametersExpand Collapse

query: BlockListParams { after, before, connected_to_agents_count_eq, 14 more }

after?: string | null

Block ID cursor for pagination. Returns blocks that come after this block ID in the specified sort order

before?: string | null

Block ID cursor for pagination. Returns blocks that come before this block ID in the specified sort order

connected_to_agents_count_eq?: Array<number> | null

Filter blocks by the exact number of connected agents. If provided, returns blocks that have exactly this number of connected agents.

connected_to_agents_count_gt?: number | null

Filter blocks by the number of connected agents. If provided, returns blocks that have more than this number of connected agents.

connected_to_agents_count_lt?: number | null

Filter blocks by the number of connected agents. If provided, returns blocks that have less than this number of connected agents.

description_search?: string | null

Search blocks by description. If provided, returns blocks that match this description. This is a full-text search on block descriptions.

identifier_keys?: Array<string> | null

Search agents by identifier keys

identity_id?: string | null

Search agents by identifier id

label?: string | null

Labels to include (e.g. human, persona)

label_search?: string | null

Search blocks by label. If provided, returns blocks that match this label. This is a full-text search on labels.

limit?: number | null

Number of blocks to return

name?: string | null

Name of the block

order?: "asc" | "desc"

Sort order for blocks by creation time. 'asc' for oldest first, 'desc' for newest first

Accepts one of the following:

"asc"

"desc"

order_by?: "created_at"

Field to sort by

Accepts one of the following:

"created_at"

project_id?: string | null

Search blocks by project id

templates_only?: boolean

Whether to include only templates

value_search?: string | null

Search blocks by value. If provided, returns blocks that match this value.

ReturnsExpand Collapse

BlockResponse { id, value, base_template_id, 15 more }

id: string

The id of the block.

value: string

Value of the block.

Deprecatedbase_template_id?: string | null

(Deprecated) The base template id of the block.

created_by_id?: string | null

The id of the user that made this Block.

Deprecateddeployment_id?: string | null

(Deprecated) The id of the deployment.

description?: string | null

Description of the block.

Deprecatedentity_id?: string | null

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

Deprecatedhidden?: boolean | null

(Deprecated) 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.

Deprecatedpreserve_on_migration?: boolean | null

(Deprecated) Preserve the block on template migration.

project_id?: string | null

The associated project id.

Deprecatedread_only?: boolean

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

Deprecatedtemplate_id?: string | null

(Deprecated) The id of the template.

Deprecatedtemplate_name?: string | null

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

List Blocks

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const blockResponse of client.blocks.list()) {
  console.log(blockResponse.id);
}

[
  {
    "id": "id",
    "value": "value",
    "base_template_id": "base_template_id",
    "created_by_id": "created_by_id",
    "deployment_id": "deployment_id",
    "description": "description",
    "entity_id": "entity_id",
    "hidden": true,
    "is_template": true,
    "label": "label",
    "last_updated_by_id": "last_updated_by_id",
    "limit": 0,
    "metadata": {
      "foo": "bar"
    },
    "preserve_on_migration": true,
    "project_id": "project_id",
    "read_only": true,
    "template_id": "template_id",
    "template_name": "template_name"
  }
]

Returns Examples

[
  {
    "id": "id",
    "value": "value",
    "base_template_id": "base_template_id",
    "created_by_id": "created_by_id",
    "deployment_id": "deployment_id",
    "description": "description",
    "entity_id": "entity_id",
    "hidden": true,
    "is_template": true,
    "label": "label",
    "last_updated_by_id": "last_updated_by_id",
    "limit": 0,
    "metadata": {
      "foo": "bar"
    },
    "preserve_on_migration": true,
    "project_id": "project_id",
    "read_only": true,
    "template_id": "template_id",
    "template_name": "template_name"
  }
]