Agents

Update agent configuration

Update agent metadata and context-engine fields.

Updatable: name, description, tags, metadata, soul_override, identity_override, user_override, skill_id, timezone, agent_memory (set to null to clear). Uses exclude_unset so omitted fields are left untouched.

patch/agents/{agent_id}

Request

  • Base URL: https://api-docs.jackhamr.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.jackhamr.ai/agents/{agent_id}
  • Auth: none declared

Path parameters

agent_idstring required

Request body

namestring nullable
descriptionstring nullable
tagsobject nullable
metadataobject nullable
soul_overridestring nullable
identity_overridestring nullable
user_overridestring nullable
skill_idstring nullable
timezonestring nullable
agent_memorystring nullable
subtitlestring nullable
subagent_max_iterationsinteger nullable

Response

Successful Response

idstring required
organization_idstring required
namestring required
descriptionstring nullable
statusstring required
owner_user_idstring nullable
allow_cloningboolean
visible_to_orgboolean
coresinteger nullable
memoryinteger nullable
disk_sizeinteger nullable
template_idstring nullable
os_templatestring nullable
size_preset_idstring nullable
sort_orderinteger
is_board_cloneboolean
clone_of_agent_idstring nullable
avatar_image_urlstring nullable
avatar_colorstring nullable
subtitlestring nullable
tagsobject nullable
metadataobject nullable
subagent_max_iterationsinteger nullable
error_messagestring nullable
last_error_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
provisioned_atstring date-time nullable
started_atstring date-time nullable
stopped_atstring date-time nullable
hibernated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.