Skip to main content
Glama

Start flow run

start_flow
Destructive

Trigger a saved Gumloop flow run through the API using a selected account and payload. Requires explicit confirmation; runs can spend credits or trigger downstream actions.

Instructions

This endpoint is used to trigger a flow run via API 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
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.
user_idNoThe id for the user initiating the flow.
project_idNo(Optional) The id of the project within which the flow is executed.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
saved_item_idNoThe id for the saved flow.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.0
    • 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."
  2. First observedv2.0.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds value beyond that by disclosing credit spend, downstream side effects, the confirmation requirement, and non-idempotent retry behavior. It does not describe the return payload, but no output schema exists and annotations carry the rest.

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?

Short and front-loaded, with the operation stated first and the confirmation warning second. 'This endpoint is used to' is mild filler, but nothing is padded or redundant.

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 destructive, non-idempotent, open-world mutation with a fully documented schema, the description covers the key risks (credits, downstream actions, confirmation, retries). It omits how to track the resulting run (e.g., get_run_details), which a fully complete definition would mention.

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

Parameters3/5

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

Schema description coverage is 100% with 7 well-documented parameters (account, confirm, payload, payload_file, saved_item_id, user_id, project_id). The description adds nothing about parameter meaning, so the schema does the heavy lifting; baseline 3 applies.

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

Purpose4/5

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

States a specific verb and resource ('trigger a flow run via API'), which is clear enough to act on. It does not differentiate from siblings like kill_flow, get_run_details, or list_flows, but the core action is unambiguous.

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

Usage Guidelines4/5

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

Gives real usage conditions: explicit confirmation is required, runs can spend credits, and unknown outcomes must not be auto-resubmitted. It names no alternatives (e.g., kill_flow to stop, get_input_schema to inspect before running), so routing guidance is incomplete but the when/when-not is clear.

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