Blocks

List Blocks

get/v1/blocks/

Create Block

post/v1/blocks/

Modify Block

patch/v1/blocks/{block_id}

Delete Block

delete/v1/blocks/{block_id}

Retrieve Block

get/v1/blocks/{block_id}

ModelsExpand Collapse

BlockResponse = object { id, value, base_template_id, 15 more }

id: string

The id of the block.

value: string

Value of the block.

Deprecatedbase_template_id: optional string

(Deprecated) The base template id of the block.

created_by_id: optional string

The id of the user that made this Block.

Deprecateddeployment_id: optional string

(Deprecated) The id of the deployment.

description: optional string

Description of the block.

Deprecatedentity_id: optional string

(Deprecated) The id of the entity within the template.

Deprecatedhidden: optional boolean

(Deprecated) If set to True, the block will be hidden.

is_template: optional boolean

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

label: optional string

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

last_updated_by_id: optional string

The id of the user that last updated this Block.

limit: optional number

Character limit of the block.

metadata: optional map[unknown]

Metadata of the block.

Deprecatedpreserve_on_migration: optional boolean

(Deprecated) Preserve the block on template migration.

project_id: optional string

The associated project id.

Deprecatedread_only: optional boolean

(Deprecated) Whether the agent has read-only access to the block.

Deprecatedtemplate_id: optional string

(Deprecated) The id of the template.

Deprecatedtemplate_name: optional string

(Deprecated) The name of the block template (if it is a template).

CreateBlock = object { label, value, base_template_id, 12 more }

Create a block

label: string

Label of the block.

value: string

Value of the block.

base_template_id: optional string

The base template id of the block.

deployment_id: optional string

The id of the deployment.

description: optional string

Description of the block.

entity_id: optional string

The id of the entity within the template.

hidden: optional boolean

If set to True, the block will be hidden.

is_template: optional boolean

limit: optional number

Character limit of the block.

metadata: optional map[unknown]

Metadata of the block.

preserve_on_migration: optional boolean

Preserve the block on template migration.

project_id: optional string

The associated project id.

read_only: optional boolean

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

template_id: optional string

The id of the template.

template_name: optional string

Name of the block if it is a template.

BlocksAgents

List Agents For Block

get/v1/blocks/{block_id}/agents