identitiesBlocks

List Blocks For Identity

Get all blocks associated with the specified identity.

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path Parameters

identity_idstringRequiredformat: "^identity-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=45 characters

The ID of the identity in the format ‘identity-<uuid4>’

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"Optional
Field to sort by

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.

Errors