identitiesBlocks

List Blocks For Identity

Get all blocks associated with the specified identity.

Path parameters

identity_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestring or nullOptional
Block ID cursor for pagination. Returns blocks that come before this block ID in the specified sort order
afterstring or nullOptional
Block ID cursor for pagination. Returns blocks that come after this block ID in the specified sort order
limitinteger or nullOptionalDefaults to 50
Maximum number of blocks to return
orderenumOptionalDefaults to desc
Sort order for blocks by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"OptionalDefaults to created_at
Field to sort by

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