Skip to main content
Glama

Update agent

update_agent
Destructive

Update an existing Gumloop agent by changing only specified fields; omitted fields remain untouched.

Instructions

Update an existing agent. Only fields included in the request body are changed; omitted fields are left untouched.

This endpoint edits document fields only. To attach or detach skills, use PATCH /agents/{agent_id}/skills; to manage MCP servers, use the agent MCP server endpoints.

is_active: false is not a pause switch. It retires the agent: the agent disappears from GET /agents, and both GET and PATCH /agents/{agent_id} return 404 afterwards, so you cannot set it back to true through the API. To stop an agent from running on its own while keeping it fully reachable, disable its triggers instead. Explicit confirmation is required for this exact account operation. Runs can spend credits or trigger downstream actions; never resubmit unknown outcomes automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
toolsNoWhen provided, replaces the agent's tool list.
accountNoNamed private Gumloop account; selects private credentials and user/team identity.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Preserves current endpoint fields and values.
team_idNoWhen provided, transfers ownership of the agent to this team.
agent_idYesID of the agent to update. Also accepts the reserved aliases `gumball` and `analytics`.
metadataNo
is_activeNo
resourcesNoWhen provided, replaces the agent's resource list.
model_nameNoID of the LLM the agent runs on. Use `GET /models` to discover valid values.
descriptionNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
system_promptNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv3.0.0
    • addedInput schema / $defs / is_active
      Added value: +{
      +  "description": "Setting this to `false` retires the agent: it disappears from `GET /agents`, and `GET`/`PATCH /agents/{agent_id}` return `404`, so it cannot be reactivated through the API. This is not a pause switch — to stop an agent from running while keeping it reachable, disable its triggers instead.\n",
      +  "type": [
      +    "boolean",
      +    "null"
      +  ]
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for this exact requested account change, agent/flow execution, upload or deletion."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / is_active / $ref
      Added value: +"#/$defs/is_active"
    • removedInput schema / properties / is_active / description
      Removed value: -"Setting this to `false` retires the agent: it disappears from `GET /agents`, and `GET`/`PATCH /agents/{agent_id}` return `404`, so it cannot be reactivated through the API. This is not a pause switch — to stop an agent from running while keeping it reachable, disable its triggers instead.\n"
    • removedInput schema / properties / is_active / type
      Removed value: -[
      -  "boolean",
      -  "null"
      -]
    • addedInput schema / properties / payload / properties / is_active / $ref
      Added value: +"#/$defs/is_active"
    • removedInput schema / properties / payload / properties / is_active / description
      Removed value: -"Setting this to `false` retires the agent: it disappears from `GET /agents`, and `GET`/`PATCH /agents/{agent_id}` return `404`, so it cannot be reactivated through the API. This is not a pause switch — to stop an agent from running while keeping it reachable, disable its triggers instead.\n"
    • removedInput schema / properties / payload / properties / is_active / type
      Removed value: -[
      -  "boolean",
      -  "null"
      -]
  2. First observedv2.0.1

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations (destructiveHint/openWorldHint/idempotentHint) by disclosing the non-obvious irreversible semantic of is_active:false — the agent disappears from GET /agents and returns 404 with no API path back. It adds the credential/confirmation requirement and warns against auto-resubmitting unknown outcomes, which is exactly the behavioral context an agent needs before a destructive write.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then scope, then the irreversible-warning, then the confirmation rule — a sensible priority order. Slightly long, and the 'runs can spend credits' line is adjacent to but not strictly about this endpoint, keeping it just short of 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 14-parameter, nested-payload mutation with no output schema, the description covers the dangerous parameter, sibling routing, and confirmation posture well. It omits mention of the payload/payload_file/body-flag exclusivity model, but that is fully documented in the schema, so what remains is minor.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 64%, and the description adds real meaning for the highest-risk parameter (is_active retirement semantics) and for confirm ('explicit confirmation is required for this exact account operation'). It does not add semantics for payload vs body-flags vs payload_file mutual exclusivity in the prose, but that is covered by the schema, so this exceeds the coverage baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Update an existing agent') and immediately scopes it ('only fields included in the request body are changed'). It explicitly carves out what this endpoint is NOT for, naming the skill and MCP-server siblings that handle those cases, so an agent can distinguish it from update_agent_skills/attach_agent_mcp_server without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit routing to alternatives ('to attach or detach skills, use PATCH /agents/{agent_id}/skills'; 'to manage MCP servers, use...') and a clear when-not for is_active ('disable its triggers instead'). It also states the confirmation precondition, so the conditions selecting this tool are fully specified.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools