blocks

Create Block

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
valuestringRequired
Value of the block.
labelstringRequired
Label of the block.
limitintegerOptionalDefaults to 20000
Character limit of the block.
project_idstring or nullOptional
The associated project id.
template_namestring or nullOptional
Name of the block if it is a template.
is_templatebooleanOptionalDefaults to false
template_idstring or nullOptional
The id of the template.
base_template_idstring or nullOptional
The base template id of the block.
deployment_idstring or nullOptional
The id of the deployment.
entity_idstring or nullOptional
The id of the entity within the template.
preserve_on_migrationboolean or nullOptionalDefaults to false
Preserve the block on template migration.
read_onlybooleanOptionalDefaults to false

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

descriptionstring or nullOptional
Description of the block.
metadatamap from strings to any or nullOptional
Metadata of the block.
hiddenboolean or nullOptional
If set to True, the block will be hidden.

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