Blocks

Retrieve Block

Path parameters

block_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Response

Successful Response
valuestring
Value of the block.
limitinteger or nullDefaults to 5000
Character limit of the block.
namestring or null
Name of the block if it is a template.
is_templateboolean or nullDefaults to false

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

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.
metadataobject or null
Metadata of the block.
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.