List Blocks
Headers
Authorization
Header authentication of the form Bearer <token>
Query parameters
label
Labels to include (e.g. human, persona)
templates_only
Whether to include only templates
name
Name of the block
identity_id
Search agents by identifier id
identifier_keys
Search agents by identifier keys
project_id
Search blocks by project id
limit
Number of blocks to return
before
Cursor for pagination. If provided, returns blocks before this cursor.
after
Cursor for pagination. If provided, returns blocks after this cursor.
label_search
Search blocks by label. If provided, returns blocks that match this label. This is a full-text search on labels.
description_search
Search blocks by description. If provided, returns blocks that match this description. This is a full-text search on block descriptions.
value_search
Search blocks by value. If provided, returns blocks that match this value.
connected_to_agents_count_gt
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
Filter blocks by the number of connected agents. If provided, returns blocks that have less than this number of connected agents.
connected_to_agents_count_eq
Filter blocks by the exact number of connected agents. If provided, returns blocks that have exactly this number of connected agents.
Response
Successful Response
value
Value of the block.
limit
Character limit of the block.
project_id
The associated project id.
name
The id of the template.
is_template
Whether the block is a template (e.g. saved human/persona options).
base_template_id
The base template id of the block.
deployment_id
The id of the deployment.
entity_id
The id of the entity within the template.
preserve_on_migration
Preserve the block on template migration.
label
Label of the block (e.g. ‘human’, ‘persona’) in the context window.
read_only
Whether the agent has read-only access to the block.
description
Description of the block.
metadata
Metadata of the block.
id
The human-friendly ID of the Block
created_by_id
The id of the user that made this Block.
last_updated_by_id
The id of the user that last updated this Block.