Get Block

GET
/v1/blocks/:block_id

Path parameters

block_idstringRequired

Response

Successful Response

valuestring

Value of the block.

limitintegerOptionalDefaults to 5000

Character limit of the block.

namestringOptional

Name of the block if it is a template.

is_templatebooleanOptionalDefaults to false

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

labelstringOptional

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

descriptionstringOptional

Description of the block.

metadata_map from strings to anyOptional

Metadata of the block.

idstringOptionalformat: "^block-[a-fA-F0-9]{8}"

The human-friendly ID of the Block

organization_idstringOptional

The unique identifier of the organization associated with the block.

created_by_idstringOptional

The id of the user that made this Block.

last_updated_by_idstringOptional

The id of the user that last updated this Block.

Errors