blocks

List Blocks

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

labelstring or nullOptional

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

templates_onlybooleanOptionalDefaults to false
Whether to include only templates
namestring or nullOptional
Name of the block
identity_idstring or nullOptional
Search agents by identifier id
identifier_keyslist of strings or nullOptional
Search agents by identifier keys
project_idstring or nullOptional
Search blocks by project id
limitinteger or nullOptionalDefaults to 50
Number of blocks to return
beforestring or nullOptional
Cursor for pagination. If provided, returns blocks before this cursor.
afterstring or nullOptional
Cursor for pagination. If provided, returns blocks after this cursor.
connected_to_agents_count_gtinteger or nullOptional
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_ltinteger or nullOptional
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_eqlist of integers or nullOptional
Filter blocks by the exact number of connected agents. If provided, returns blocks that have exactly this number of connected agents.

Response

Successful Response
valuestring
Value of the block.
limitinteger or nullDefaults to 20000
Character limit of the block.
project_idstring or null
The associated project id.
namestring or null
The id of the template.
is_templateboolean or nullDefaults to false

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

base_template_idstring or null
The base template id of the block.
deployment_idstring or null
The id of the deployment.
entity_idstring or null
The id of the entity within the template.
preserve_on_migrationboolean or nullDefaults to false
Preserve the block on template migration.
labelstring or null

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

read_onlyboolean or nullDefaults to false

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

descriptionstring or null
Description of the block.
metadatamap from strings to any or null
Metadata of the block.
hiddenboolean or null
If set to True, the block will be hidden.
idstring or nullformat: "^block-[a-fA-F0-9]{8}"

The human-friendly ID 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.

Errors