Letta · Schema

BlockUpdate

Update a block

AIAgentsStateful AgentsMemoryMemGPTContinual LearningMCPMulti-AgentRAGOpen Source

Properties

Name Type Description
value object Value of the block.
limit object Character limit of the block.
project_id object The associated project id.
template_name object Name of the block if it is a template.
is_template boolean Whether the block is a template (e.g. saved human/persona options).
template_id object The id of the template.
base_template_id object The base template id of the block.
deployment_id object The id of the deployment.
entity_id object The id of the entity within the template.
preserve_on_migration object Preserve the block on template migration.
label object Label of the block (e.g. 'human', 'persona') in the context window.
read_only boolean Whether the agent has read-only access to the block.
description object Description of the block.
metadata object Metadata of the block.
hidden object If set to True, the block will be hidden.
tags object The tags to associate with the block.
View JSON Schema on GitHub

JSON Schema

letta-blockupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BlockUpdate",
  "title": "BlockUpdate",
  "properties": {
    "value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Value",
      "description": "Value of the block."
    },
    "limit": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Limit",
      "description": "Character limit of the block."
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id",
      "description": "The associated project id."
    },
    "template_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Template Name",
      "description": "Name of the block if it is a template."
    },
    "is_template": {
      "type": "boolean",
      "title": "Is Template",
      "description": "Whether the block is a template (e.g. saved human/persona options).",
      "default": false
    },
    "template_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Template Id",
      "description": "The id of the template."
    },
    "base_template_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Base Template Id",
      "description": "The base template id of the block."
    },
    "deployment_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deployment Id",
      "description": "The id of the deployment."
    },
    "entity_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Entity Id",
      "description": "The id of the entity within the template."
    },
    "preserve_on_migration": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Preserve On Migration",
      "description": "Preserve the block on template migration.",
      "default": false
    },
    "label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Label",
      "description": "Label of the block (e.g. 'human', 'persona') in the context window."
    },
    "read_only": {
      "type": "boolean",
      "title": "Read Only",
      "description": "Whether the agent has read-only access to the block.",
      "default": false
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "description": "Description of the block."
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata",
      "description": "Metadata of the block.",
      "default": {}
    },
    "hidden": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hidden",
      "description": "If set to True, the block will be hidden."
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tags",
      "description": "The tags to associate with the block."
    }
  },
  "type": "object",
  "description": "Update a block"
}