vf function get-schema

vf function get-schema: get function schema. Requires --environment-alias, --function-id and --project-id, with a worked example.

Last updated Oct 19, 2026

List the inputs, output variables and exit paths of a function, as execute takes and returns them.

Usage

vf function get-schema [flags]

Examples

  vf function get-schema --function-id <id> --project-id <id> --environment-alias <value>

Flags

  -e, --environment-alias string   [required]
  -f, --function-id string         [required]
  -h, --help                       help for get-schema
  -p, --project-id string          [required]

Global 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 format

See also

vf function - Operations for function