Update an API tool by ID.
Usage
vf api-tool update [flags]Examples
vf api-tool update --tool-id <id> --project-id <id> --environment-alias <value>Flags
--body string Request body as JSON (alternative to individual flags). Can also be provided via stdin.
-b, --body-param string JSON value (variants: raw-input: { type: string, contentType: string, content: string }, form-data: { type: string, formData: object[] }, url-encoded: { type: string, params: object[] })
--body-param.form-data string StableAPIToolUpdateRequestV2_StableAPIToolFormDataBody variant as JSON
--body-param.raw-input string StableAPIToolUpdateRequestV2_StableAPIToolRawBody variant as JSON
--body-param.raw-input.content string Plain text. {input_name} inserts one of THIS API tool's declared input variables — not a project variable and not a secret. {input_name.path} reads a field of that input; the declared input is the base name, so {order.id} declares an input named order. Escape a literal { or \ with a backslash. A name matching no declared input declares one on this tool as part of the write. A bare 24-hex token is the residue of a deleted reference rather than a name: it declares nothing and is reported as resource-id. Until an attachment binds a default for it, a declared input is filled by the model at runtime. A credential reaches an API tool through the attachment's inputVariables[<name>].defaultValue. [required]
--body-param.raw-input.content-type string options: text, json, xml
--body-param.url-encoded string StableAPIToolUpdateRequestV2_StableAPIToolURLEncodedBody variant as JSON
--description string A description of what the API tool does, used by the agent to decide when to call it.
-e, --environment-alias string [required]
--headers string list of values
-h, --help help for update
--http-method string options: get, put, post, patch, delete
-n, --name string string value
-p, --project-id string [required]
--query-parameters string list of values
-s, --settings string JSON object
-t, --tool-id string [required]
-u, --url string string valueGlobal flags
These flags are inherited from the parent command and work on every invocation.
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
-d, --debug Log request and response diagnostics to stderr
--dry-run Preview the request that would be sent without executing it (output to stderr)
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
--include-headers Include HTTP response headers in the output
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
--server-url string Override the default server URL
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
--token string Voiceflow bearer token
--usage Print the CLI Usage schema in KDL formatSee also
- vf api-tool - Operations for api-tool