Sign in

v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
workflows

Get Workflow

Get a specific workflow by ID.

The workflow must belong to the authenticated organization.

get/v1/workflows/{workflow_id}

Path parameters

workflow_idstring uuid required

Query parameters

includestring nullable

Comma-separated list of related resources to include. Allowed values: tags, post_run_checks. Defaults to tags and post_run_checks when omitted.

Comma-separated list of related resources to include. Allowed values: tags, post_run_checks. Defaults to tags and post_run_checks when omitted.

Response

Successful Response

namestring nullable
main_promptstring required
input_schemastring nullable

JSON schema for validating merged run inputs. Sensitive root keys are exposed with a '$' prefix in schema validation (for example sensitive_input_values.api_key -> '$api_key').

output_schemastring nullable

JSON schema for output data transformation

includes_file_exportsboolean

Enable AI-based file export detection

is_webhooks_enabledboolean

Send webhook on run completion

terminal_command_allowliststring[] nullable

Optional workflow-level allowlist for execute_terminal_command. When set, the agent may only run commands that exactly match one of the approved command templates.

post_run_check_failure_cleanup_promptstring nullable

Optional workflow-level cleanup prompt that runs when any post-run check fails during a session or chain.

idstring uuid required
user_idstring uuid nullable
organization_idstring nullable
includes_input_variablesboolean
old_versionsobject[] nullable
created_atstring date-time required
updated_atstring date-time required