agents

Modify Approval

Attach a tool to an agent.

patch/v1/agents/{agent_id}/tools/approval/{tool_name}

Path parameters

agent_idstring required

tool_namestring required

Query parameters

requires_approvalboolean required

Response

Successful Response

created_by_idstring nullable

The id of the user that made this object.

last_updated_by_idstring nullable

The id of the user that made this object.

created_atstring date-time nullable

The timestamp when the object was created.

updated_atstring date-time nullable

The timestamp when the object was last updated.

idstring required

The id of the agent. Assigned by the database.

namestring required

The name of the agent.

message_idsstring[] nullable

The ids of the messages in the agent's in-context memory.

systemstring required

The system prompt used by the agent.

Enum to represent the type of agent.

descriptionstring nullable

The description of the agent.

metadataobject nullable

The metadata of the agent.

tagsstring[] required

The tags associated with the agent.

project_idstring nullable

The id of the project the agent belongs to.

template_idstring nullable

The id of the template the agent belongs to.

base_template_idstring nullable

The base template id of the agent.

deployment_idstring nullable

The id of the deployment.

entity_idstring nullable

The id of the entity within the template.

identity_idsstring[]

The ids of the identities associated with this agent.

message_buffer_autoclearboolean

If set to True, the agent will not remember previous messages (though the agent will still retain state via core memory blocks and archival/recall memory). Not recommended unless you have an advanced use case.

enable_sleeptimeboolean nullable

If set to True, memory management will move to a background agent thread.

last_run_completionstring date-time nullable

The timestamp when the agent last completed a run.

last_run_duration_msinteger nullable

The duration in milliseconds of the agent's last run.

timezonestring nullable

The timezone of the agent (IANA format).

max_files_openinteger nullable

Maximum number of files that can be open at once for this agent. Setting this too high may exceed the context window, which will break the agent.

per_file_view_window_char_limitinteger nullable

The per-file view window character limit for this agent. Setting this too high may exceed the context window, which will break the agent.

hiddenboolean nullable

If set to True, the agent will be hidden.

Example response

{
  "memory": {
    "blocks": [
      {
        "id": "block-123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "file_blocks": [
      {
        "id": "block-123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "tools": [
    {
      "id": "tool-123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "sources": [
    {
      "id": "source-123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "tool_exec_environment_variables": [
    {
      "id": "agent-env-123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "secrets": [
    {
      "id": "agent-env-123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

Changed in 6 of the 36 revisions of this API.1113

Oct 9, 20256cec99480c132See the full diff
- ○
  added the optional property secrets/items/value_enc to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_exec_environment_variables/items/value_enc to the response with the 200 status
  response-optional-property-added
Oct 1, 202517b1c4a592761See the full diff
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #1: ChildToolRule]/child_arg_nodes to the response with the 200 status
  response-optional-property-added
Oct 1, 202505c8e12a3c8f1See the full diff
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #2: InitToolRule]/args to the response with the 200 status
  response-optional-property-added
Oct 1, 20254d0fc5930af29See the full diff
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #1: ChildToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #2: InitToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #3: TerminalToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #4: ConditionalToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #5: ContinueToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #6: RequiredBeforeExitToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #7: MaxCountPerStepToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #8: ParentToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #9: RequiresApprovalToolRule]/requires_force_tool_call from the response with the 200 status
  response-optional-property-removed
Sep 30, 20250f16359792139See the full diff
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #1: ChildToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #2: InitToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #3: TerminalToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #4: ConditionalToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #5: ContinueToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #6: RequiredBeforeExitToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #7: MaxCountPerStepToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #8: ParentToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tool_rules/anyOf[subschema #1]/items/oneOf[subschema #9: RequiresApprovalToolRule]/requires_force_tool_call to the response with the 200 status
  response-optional-property-added
Sep 24, 202568c3c741b8732See the full diff
- ●
  added the new letta_v1_agent enum value to the agent_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new letta_v1_agent enum value to the memory/agent_type/anyOf[subschema #1: AgentType]/ response property for the response status 200
  response-property-enum-value-added

Full history