Skip to main content

Module models

Module models 

Source

Modules§

accept_invite_request
add_owner_to_folder_request
add_user_request
add_user_to_group_request
add_user_to_instance_group_request
agent_tool
ai_agent
ai_agent_input_transforms
ai_config
ai_provider
ai_provider_config
ai_provider_kind
ai_provider_model
ai_transform
alert
app_history
app_with_last_version
app_with_last_version_w_draft
archive_flow_by_path_request
asset
asset_kind
asset_usage_access_type
asset_usage_kind
audit_log
authentication_method
auto_invite_config
autoscaling_event
aws_auth_resource_type
aws_secrets_manager_settings
azure_arm_resource
azure_delete_subscription
azure_key_vault_settings
azure_list_subscriptions
azure_list_topics
azure_mode
azure_trigger
azure_trigger_data
batch_re_run_jobs_request
batch_re_run_jobs_request_script_options_by_path_value
blacklist_agent_token_request
branch_all
branch_all_branches_inner
branch_one
branch_one_branches_inner
cancel_queued_job_request
cancel_suspended_trigger_jobs_request
capture
capture_config
capture_trigger_kind
change_workspace_color_request
change_workspace_id_request
change_workspace_name_request
channel_info
check_s3_folder_exists_200_response
ci_test_result
commit_kafka_offsets_request
compare_summary
completed_job
concurrency_group
config
configs
connect_client_credentials_request
connect_slack_callback_request
connect_slack_request
connect_teams_request
contextual_variable
count_jobs_by_tag_200_response_inner
count_search_logs_index_200_response
create_account_request
create_agent_token_request
create_app_request
create_deployment_request_comment_request
create_deployment_request_request
create_draft_request
create_flow_request
create_folder_request
create_input
create_instance_group_request
create_pg_database_request
create_protection_rule_request
create_resource
create_service_account_request
create_trigger_response
create_user_globally_request
create_variable
create_workspace
create_workspace_fork
create_workspace_fork_forked_datatables_inner
critical_alert
custom_instance_db
custom_instance_db_logs
custom_instance_db_tag
data_table_schema
data_table_settings
data_table_settings_datatables_value
data_table_settings_datatables_value_database
data_table_settings_datatables_value_forked_from
data_table_table_schema
data_table_tables
database_health
decline_invite_request
delete_gcp_subscription
delete_git_sync_repository_request
delete_invite_request
delete_variables_bulk_request
delivery_type
dependency_dependent
dependency_map
dependents_amount
deployment_request
deployment_request_assignee
deployment_request_comment
deployment_request_eligible_deployer
detailed_health_response
diff_raw_scripts_with_deployed_request
diff_raw_scripts_with_deployed_request_workspace_deps_inner
discover_mcp_o_auth_200_response
discover_mcp_o_auth_request
drop_forked_datatable_databases_request
duckdb_connection_settings_200_response
duckdb_connection_settings_request
duckdb_connection_settings_v2_200_response
duckdb_connection_settings_v2_request
ducklake_settings
ducklake_settings_ducklakes_value
ducklake_settings_ducklakes_value_catalog
ducklake_settings_ducklakes_value_storage
dynamic_input_data
dynamic_input_data_runnable_ref
dynamic_input_data_runnable_ref_one_of
dynamic_input_data_runnable_ref_one_of_1
edit_auto_invite_request
edit_copilot_config_200_response
edit_data_table_config_request
edit_ducklake_config_request
edit_email_trigger
edit_error_handler
edit_error_handler_legacy
edit_error_handler_new
edit_git_sync_repository_request
edit_http_trigger
edit_instance_groups_request
edit_kafka_trigger
edit_large_file_storage_config_request
edit_mqtt_trigger
edit_nats_trigger
edit_postgres_trigger
edit_resource
edit_resource_type
edit_schedule
edit_slack_command_request
edit_sqs_trigger
edit_success_handler
edit_success_handler_legacy
edit_success_handler_new
edit_variable
edit_webhook_request
edit_websocket_trigger
edit_workspace_default_app_request
edit_workspace_deploy_ui_settings_request
edit_workspace_git_sync_config_request
edit_workspace_user
email_trigger
endpoint_tool
error_handler
error_handler_config
execute_component_request
execute_component_request_raw_code
exists_email_local_part_request
exists_route_request
exists_username_request
exists_workspace_request
export_installation_200_response
export_pg_schema_request
exportable_completed_job
exportable_queued_job
exported_instance_group
exported_user
extended_jobs
external_jwt_token
file_resource_type_to_file_ext_map_200_response_value
file_upload_200_response
flow
flow_conversation
flow_conversation_message
flow_group
flow_metadata
flow_module
flow_module_debouncing
flow_module_mock
flow_module_skip_if
flow_module_suspend
flow_module_suspend_resume_form
flow_module_tool
flow_module_value
flow_note
flow_note_position
flow_note_size
flow_preview
flow_status
flow_status_failure_module
flow_status_module
flow_status_module_agent_actions_inner
flow_status_module_agent_actions_inner_one_of
flow_status_module_agent_actions_inner_one_of_1
flow_status_module_agent_actions_inner_one_of_2
flow_status_module_agent_actions_inner_one_of_3
flow_status_module_branch_chosen
flow_status_module_branchall
flow_status_module_flow_jobs_duration
flow_status_module_iterator
flow_status_retry
flow_value
flow_version
folder
folder_default_permissioned_as_inner
forloop_flow
gcp_trigger
gcp_trigger_data
generate_openapi_spec
get_all_topic_subscription
get_approval_info_200_response
get_approval_info_200_response_approval_conditions
get_approval_info_200_response_approvers_inner
get_ci_test_results_batch_request
get_ci_test_results_batch_request_items_inner
get_cloud_quotas_200_response
get_completed_count_200_response
get_completed_job_result_maybe_200_response
get_completed_job_timing_200_response
get_copilot_settings_state_200_response
get_critical_alerts_200_response
get_datatable_full_schema_200_response_value_value
get_datatable_full_schema_200_response_value_value_columns_inner
get_datatable_full_schema_200_response_value_value_foreign_keys_inner
get_datatable_full_schema_200_response_value_value_foreign_keys_inner_columns_inner
get_datatable_full_schema_request
get_deploy_to_200_response
get_entitlements_200_response
get_flow_by_path_with_draft_200_response
get_flow_deployment_status_200_response
get_folder_permission_history_200_response_inner
get_folder_usage_200_response
get_ghes_config_200_response
get_git_commit_hash_200_response
get_git_sync_enabled_200_response
get_github_app_token_200_response
get_github_app_token_request
get_group_permission_history_200_response_inner
get_hub_app_by_id_200_response
get_hub_app_by_id_200_response_app
get_hub_flow_by_id_200_response
get_hub_script_by_path_200_response
get_index_disk_storage_sizes_200_response
get_index_storage_sizes_200_response
get_index_storage_sizes_200_response_job_index
get_indexer_status_200_response
get_indexer_status_200_response_job_indexer
get_job_metrics_200_response
get_job_metrics_request
get_job_updates_200_response
get_latest_key_renewal_attempt_200_response
get_log_cleanup_status_200_response
get_mcp_tools_200_response_inner
get_min_keep_alive_version_200_response
get_npm_package_filetree_200_response
get_npm_package_filetree_200_response_files_inner
get_npm_package_metadata_200_response
get_o_auth_connect_200_response
get_object_storage_usage_200_response
get_object_storage_usage_200_response_folders_inner
get_premium_info_200_response
get_public_app_by_custom_path_200_response
get_public_settings_200_response
get_queue_count_200_response
get_queue_metrics_200_response_inner
get_queue_metrics_200_response_inner_values_inner
get_queue_position_200_response
get_resume_urls_200_response
get_runnable_200_response
get_script_deployment_status_200_response
get_settings_200_response
get_shared_ui_200_response
get_shared_ui_version_200_response
get_stats_200_response
get_suspended_job_flow_200_response
get_threshold_alert_200_response
get_top_hub_scripts_200_response
get_top_hub_scripts_200_response_asks_inner
get_tutorial_progress_200_response
get_used_triggers_200_response
get_workspace_default_app_200_response
get_workspace_encryption_key_200_response
get_workspace_slack_oauth_config_200_response
ghes_installation_callback_request
git_repository_settings
git_repository_settings_settings
git_sync_object_type
github_installations_inner
github_installations_inner_repositories_inner
github_repo_entry
global_offboard_preview
global_offboard_request
global_setting
global_user_info
global_user_rename_request
global_user_update_request
global_username_info_200_response
global_username_info_200_response_workspace_usernames_inner
google_calendar_entry
google_drive_file
google_drive_files_response
group
health_checks
health_status_response
http_method
http_request_type
http_trigger
hub_script_kind
identity
import_installation_request
import_pg_database_request
inline_script_args
input
input_transform
install_from_workspace_request
instance_ai_provider_summary
instance_ai_summary
instance_config
instance_group
instance_group_with_workspaces
invite_user_request
javascript_transform
job
job_one_of
job_one_of_1
job_search_hit
job_trigger_kind
jwks_response
kafka_trigger
language
large_file_storage
large_file_storage_secondary_storage_value
list_all_dedicated_with_deps_200_response_inner
list_all_workspace_dependencies_200_response_inner
list_assets_200_response
list_assets_200_response_assets_inner
list_assets_200_response_assets_inner_metadata
list_assets_200_response_assets_inner_usages_inner
list_assets_200_response_assets_inner_usages_inner_metadata
list_assets_200_response_next_cursor
list_assets_by_usage_200_response_inner_inner
list_assets_by_usage_request
list_assets_by_usage_request_usages_inner
list_available_teams_channels_200_response
list_available_teams_channels_200_response_channels_inner
list_available_teams_ids_200_response
list_available_teams_ids_200_response_teams_inner
list_blacklisted_agent_tokens_200_response_inner
list_data_tables_200_response_inner
list_dedicated_with_deps_200_response_inner
list_favorite_assets_200_response_inner
list_flows_200_response_inner
list_hub_apps_200_response
list_hub_apps_200_response_apps_inner
list_hub_flows_200_response
list_hub_flows_200_response_flows_inner
list_hub_integrations_200_response_inner
list_log_files_200_response_inner
list_o_auth_logins_200_response
list_o_auth_logins_200_response_oauth_inner
list_resource_names_200_response_inner
list_search_resource_200_response_inner
list_search_script_200_response_inner
list_selected_job_groups_200_response_inner
list_selected_job_groups_200_response_inner_schemas_inner
list_shared_ui_200_response
list_stored_files_200_response
list_worker_groups_200_response_inner
list_ws_specific_200_response_inner
listable_app
listable_raw_app
listable_resource
listable_variable
load_table_row_count_200_response
log_ai_chat_request
log_search_hit
logged_wizard_status
login
login_with_oauth_request
main_arg_signature
main_arg_signature_args_inner
main_arg_signature_args_inner_typ
main_arg_signature_args_inner_typ_one_of
main_arg_signature_args_inner_typ_one_of_1
main_arg_signature_args_inner_typ_one_of_2
main_arg_signature_args_inner_typ_one_of_3
main_arg_signature_args_inner_typ_one_of_2_object
main_arg_signature_args_inner_typ_one_of_2_object_props_inner
main_arg_signature_args_inner_typ_one_of_2_object_props_inner_typ
main_arg_signature_args_inner_typ_one_of_2_object_props_inner_typ_one_of
main_arg_signature_args_inner_typ_one_of_3_list
mcp_tool_value
memory_auto
memory_config
memory_manual
memory_message
memory_off
memory_transform
metric_data_point
metric_metadata
move_captures_and_configs_request
mqtt_client_version
mqtt_qo_s
mqtt_subscribe_topic
mqtt_trigger
mqtt_v3_config
mqtt_v5_config
native_service_name
native_trigger
native_trigger_data
native_trigger_service_callback_request
native_trigger_with_external
nats_trigger
new_email_trigger
new_http_trigger
new_http_trigger_static_asset_config
new_kafka_trigger
new_mqtt_trigger
new_nats_trigger
new_postgres_trigger
new_schedule
new_script
new_script_assets_inner
new_script_with_draft
new_sqs_trigger
new_token
new_token_impersonate
new_websocket_trigger
new_websocket_trigger_filters_inner
new_workspace_dependencies
next_cloud_event_type
obscured_job
offboard_affected_paths
offboard_preview
offboard_request
offboard_response
offboard_summary
offboard_token_info
open_flow
open_flow_w_path
openapi_http_route_filters
openapi_spec_format
openapi_v3_info
openapi_v3_info_contact
openapi_v3_info_license
operator_settings
orvanta_file_metadata
orvanta_file_preview
orvanta_large_file
password_reset_response
path_flow
path_script
pick_hub_script_by_path_200_response
polars_client_kwargs
polars_connection_settings_200_response
polars_connection_settings_v2_200_response
polars_connection_settings_v2_200_response_storage_options
policy
policy_allowed_s3_keys_inner
pool_stats
postgres_trigger
preview
preview_inline
preview_schedule_request
protection_rule_kind
protection_ruleset
provider_config
provider_transform
prune_versions_200_response
prune_versions_request
publication_data
push_config
query_documentation_request
query_hub_scripts_200_response_inner
query_resource_types_200_response_inner
queue_health
queued_job
quota_info
raw_script
raw_script_assets_inner
raw_script_for_dependencies
readiness_health
redirect_uri
refresh_token_request
relations
remove_blacklist_agent_token_request
remove_owner_to_folder_request
request_password_reset_request
reset_password_request
resolve_npm_package_version_200_response
resource
resource_type
restart_flow_at_step_request
restart_flow_at_step_request_nested_path_inner
restarted_from
restarted_from_branch_chosen
resume_suspended_request
resume_suspended_trigger_jobs_request
retry
retry_constant
retry_exponential
retry_if
run_flow_dependencies_async_request
run_raw_script_dependencies_201_response
run_raw_script_dependencies_request
run_slack_message_test_job_200_response
run_slack_message_test_job_request
runnable_kind
runnable_type
s3_object
s3_permission_rule
s3_resource
scalar_metric
schedule
schedule_w_jobs
schedule_w_jobs_all_of_jobs
scope_definition
scope_domain
script
script_history
script_lang
script_module
search_jobs_index_200_response
search_jobs_index_200_response_index_metadata
search_logs_index_200_response
secret_migration_failure
secret_migration_report
send_message_to_conversation_request
set_capture_config_request
set_default_error_or_recovery_handler_request
set_environment_variable_request
set_global_request
set_http_trigger_mode_request
set_job_progress_request
set_login_type_for_user_request
set_password_request
set_public_app_rate_limit_request
set_schedule_enabled_request
set_threshold_alert_request
set_workspace_encryption_key_request
set_workspace_slack_oauth_config_request
setup_custom_instance_db_request
shared_drive_entry
sign_s3_objects_request
slack_token
slack_token_team
slot
slot_list
sqs_trigger
star_request
static_memory_transform
static_provider_transform
static_transform
stop_after_if
submit_onboarding_data_request
subscription_mode
success_handler_config
sync_result
table_to_track_inner
team_info
teams_channel
template_script
test_azure_connection
test_critical_channels_request_inner
test_kafka_connection_request
test_license_key_request
test_postgres_connection_request
test_smtp_request
test_smtp_request_smtp
test_websocket_connection_request
timeseries_metric
toggle_workspace_error_handler_for_script_request
token_response
tool_value
trigger_extra_property
trigger_mode
triggers_count
triggers_count_primary_schedule
truncated_token
update_app_request
update_flow_history_request
update_flow_request
update_folder_request
update_group_request
update_input
update_instance_group_request
update_protection_rule_request
update_script_history_request
update_shared_ui_request
update_token_scopes_request
upload_s3_file_from_app_200_response
user
user_source
user_usage
user_workspace_list
user_workspace_list_workspaces_inner
vault_settings
volume
webhook_event
webhook_filters
webhook_request_type
websearch_tool_value
websocket_heartbeat
websocket_trigger
websocket_trigger_initial_message
websocket_trigger_initial_message_any_of
websocket_trigger_initial_message_any_of_1
websocket_trigger_initial_message_any_of_1_runnable_result
whileloop_flow
worker_ping
workers_health
workflow_status
workflow_task
workspace
workspace_comparison
workspace_default_scripts
workspace_dependencies
workspace_deploy_ui_settings
workspace_git_sync_settings
workspace_github_installation
workspace_info
workspace_integrations
workspace_invite
workspace_item_diff
workspace_mute_critical_alerts_ui_request
workspace_o_auth_config
workspace_offboard_preview
workspace_reassignment

Structs§

AcceptInviteRequest
AddOwnerToFolderRequest
AddUserRequest
AddUserToGroupRequest
AddUserToInstanceGroupRequest
AgentTool
AgentTool : A tool available to an AI agent. Can be a flow module or an external MCP (Model Context Protocol) tool
AiAgent
AiAgent : AI agent step that can use tools to accomplish tasks. The agent receives inputs and can call any of its configured tools to complete the task
AiAgentInputTransforms
AiAgentInputTransforms : Input parameters for the AI agent mapped to their values
AiConfig
AiProviderConfig
AiProviderModel
AiTransform
AiTransform : Value resolved by the AI runtime for this input. The AI engine decides how to satisfy the parameter.
Alert
AppHistory
AppWithLastVersion
AppWithLastVersionWDraft
ArchiveFlowByPathRequest
Asset
AuditLog
AutoInviteConfig
AutoInviteConfig : Configuration for auto-inviting users to the workspace
AutoscalingEvent
AwsSecretsManagerSettings
AzureArmResource
AzureArmResource : An ARM resource the service principal can see.
AzureDeleteSubscription
AzureKeyVaultSettings
AzureListSubscriptions
AzureListTopics
AzureTrigger
AzureTrigger : An Azure Event Grid trigger that executes a script or flow when events arrive.
AzureTriggerData
AzureTriggerData : Data for creating or updating an Azure Event Grid trigger.
BatchReRunJobsRequest
BatchReRunJobsRequestScriptOptionsByPathValue
BlacklistAgentTokenRequest
BranchAll
BranchAll : Parallel branching where all branches execute simultaneously. Unlike BranchOne, all branches run regardless of conditions. Useful for executing independent tasks concurrently
BranchAllBranchesInner
BranchOne
BranchOne : Conditional branching where only the first matching branch executes. Branches are evaluated in order, and the first one with a true expression runs. If no branches match, the default branch executes
BranchOneBranchesInner
CancelQueuedJobRequest
CancelSuspendedTriggerJobsRequest
Capture
CaptureConfig
ChangeWorkspaceColorRequest
ChangeWorkspaceIdRequest
ChangeWorkspaceNameRequest
ChannelInfo
CheckS3FolderExists200Response
CiTestResult
CommitKafkaOffsetsRequest
CompareSummary
CompletedJob
ConcurrencyGroup
Config
Configs
ConnectClientCredentialsRequest
ConnectSlackCallbackRequest
ConnectSlackRequest
ConnectTeamsRequest
ContextualVariable
CountJobsByTag200ResponseInner
CountSearchLogsIndex200Response
CreateAccountRequest
CreateAgentTokenRequest
CreateAppRequest
CreateDeploymentRequestCommentRequest
CreateDeploymentRequestRequest
CreateDraftRequest
CreateFlowRequest
CreateFolderRequest
CreateInput
CreateInstanceGroupRequest
CreatePgDatabaseRequest
CreateProtectionRuleRequest
CreateResource
CreateServiceAccountRequest
CreateTriggerResponse
CreateTriggerResponse : Response returned when a native trigger is created
CreateUserGloballyRequest
CreateVariable
CreateWorkspace
CreateWorkspaceFork
CreateWorkspaceForkForkedDatatablesInner
CriticalAlert
CustomInstanceDb
CustomInstanceDbLogs
DataTableSchema
DataTableSettings
DataTableSettingsDatatablesValue
DataTableSettingsDatatablesValueDatabase
DataTableSettingsDatatablesValueForkedFrom
DataTableSettingsDatatablesValueForkedFrom : Fork origin info with schema snapshot
DataTableTableSchema
DataTableTables
DatabaseHealth
DatabaseHealth : Database health status
DeclineInviteRequest
DeleteGcpSubscription
DeleteGitSyncRepositoryRequest
DeleteInviteRequest
DeleteVariablesBulkRequest
DependencyDependent
DependencyMap
DependentsAmount
DeploymentRequest
DeploymentRequestAssignee
DeploymentRequestComment
DeploymentRequestEligibleDeployer
DetailedHealthResponse
DetailedHealthResponse : Detailed health status response (always fresh, no caching)
DiffRawScriptsWithDeployedRequest
DiffRawScriptsWithDeployedRequestWorkspaceDepsInner
DiscoverMcpOAuth200Response
DiscoverMcpOAuthRequest
DropForkedDatatableDatabasesRequest
DuckdbConnectionSettings200Response
DuckdbConnectionSettingsRequest
DuckdbConnectionSettingsV2Request
DuckdbConnectionSettingsV2200Response
DucklakeSettings
DucklakeSettingsDucklakesValue
DucklakeSettingsDucklakesValueCatalog
DucklakeSettingsDucklakesValueStorage
DynamicInputData
DynamicInputDataRunnableRefOneOf
DynamicInputDataRunnableRefOneOf1
EditAutoInviteRequest
EditCopilotConfig200Response
EditDataTableConfigRequest
EditDucklakeConfigRequest
EditEmailTrigger
EditErrorHandlerLegacy
EditErrorHandlerLegacy : Legacy flat format for editing error handler (deprecated, use new format)
EditErrorHandlerNew
EditErrorHandlerNew : New grouped format for editing error handler
EditGitSyncRepositoryRequest
EditHttpTrigger
EditInstanceGroupsRequest
EditKafkaTrigger
EditLargeFileStorageConfigRequest
EditMqttTrigger
EditNatsTrigger
EditPostgresTrigger
EditResource
EditResourceType
EditSchedule
EditSlackCommandRequest
EditSqsTrigger
EditSuccessHandlerLegacy
EditSuccessHandlerLegacy : Legacy flat format for editing success handler (deprecated, use new format)
EditSuccessHandlerNew
EditSuccessHandlerNew : New grouped format for editing success handler
EditVariable
EditWebhookRequest
EditWebsocketTrigger
EditWorkspaceDefaultAppRequest
EditWorkspaceDeployUiSettingsRequest
EditWorkspaceGitSyncConfigRequest
EditWorkspaceUser
EmailTrigger
EndpointTool
ErrorHandlerConfig
ErrorHandlerConfig : Configuration for the workspace error handler
ExecuteComponentRequest
ExecuteComponentRequestRawCode
ExistsEmailLocalPartRequest
ExistsRouteRequest
ExistsUsernameRequest
ExistsWorkspaceRequest
ExportInstallation200Response
ExportPgSchemaRequest
ExportableCompletedJob
ExportableCompletedJob : Completed job with full data for export/import operations
ExportableQueuedJob
ExportableQueuedJob : Queued job with full data for export/import operations
ExportedInstanceGroup
ExportedUser
ExtendedJobs
ExternalJwtToken
FileResourceTypeToFileExtMap200ResponseValue
FileUpload200Response
Flow
FlowConversation
FlowConversationMessage
FlowGroup
FlowGroup : A semantic group of flow modules for organizational purposes. Does not affect execution — modules remain in their original position in the flow. Groups provide naming and collapsibility in the editor. Members are computed dynamically from all nodes on paths between start_id and end_id.
FlowMetadata
FlowModule
FlowModule : A single step in a flow. Can be a script, subflow, loop, or branch
FlowModuleDebouncing
FlowModuleDebouncing : Debounce configuration for this step (EE only)
FlowModuleMock
FlowModuleMock : Mock configuration for testing without executing the actual step
FlowModuleSkipIf
FlowModuleSkipIf : Conditionally skip this step based on previous results or flow inputs
FlowModuleSuspend
FlowModuleSuspend : Configuration for approval/resume steps that wait for user input
FlowModuleSuspendResumeForm
FlowModuleSuspendResumeForm : Form schema for collecting input when resuming
FlowModuleTool
FlowModuleTool : A tool implemented as a flow module (script, flow, etc.). The AI can call this like any other flow module
FlowNote
FlowNote : A sticky note attached to a flow for documentation and annotation
FlowNotePosition
FlowNotePosition : Position of the note in the flow editor
FlowNoteSize
FlowNoteSize : Size of the note in the flow editor
FlowPreview
FlowStatus
FlowStatusFailureModule
FlowStatusModule
FlowStatusModuleAgentActionsInnerOneOf
FlowStatusModuleAgentActionsInnerOneOf1
FlowStatusModuleAgentActionsInnerOneOf2
FlowStatusModuleAgentActionsInnerOneOf3
FlowStatusModuleBranchChosen
FlowStatusModuleBranchall
FlowStatusModuleFlowJobsDuration
FlowStatusModuleIterator
FlowStatusRetry
FlowValue
FlowValue : The flow structure containing modules and optional preprocessor/failure handlers
FlowVersion
Folder
FolderDefaultPermissionedAsInner
ForloopFlow
ForloopFlow : Executes nested modules in a loop over an iterator. Inside the loop, use ‘flow_input.iter.value’ to access the current iteration value, and ‘flow_input.iter.index’ for the index. Supports parallel execution for better performance on I/O-bound operations
GcpTrigger
GcpTrigger : A Google Cloud Pub/Sub trigger that executes a script or flow when messages are received.
GcpTriggerData
GcpTriggerData : Data for creating or updating a Google Cloud Pub/Sub trigger.
GenerateOpenapiSpec
GetAllTopicSubscription
GetApprovalInfo200Response
GetApprovalInfo200ResponseApprovalConditions
GetApprovalInfo200ResponseApproversInner
GetCiTestResultsBatchRequest
GetCiTestResultsBatchRequestItemsInner
GetCloudQuotas200Response
GetCompletedCount200Response
GetCompletedJobResultMaybe200Response
GetCompletedJobTiming200Response
GetCopilotSettingsState200Response
GetCriticalAlerts200Response
GetDatatableFullSchema200ResponseValueValue
GetDatatableFullSchema200ResponseValueValueColumnsInner
GetDatatableFullSchema200ResponseValueValueForeignKeysInner
GetDatatableFullSchema200ResponseValueValueForeignKeysInnerColumnsInner
GetDatatableFullSchemaRequest
GetDeployTo200Response
GetEntitlements200Response
GetFlowByPathWithDraft200Response
GetFlowDeploymentStatus200Response
GetFolderPermissionHistory200ResponseInner
GetFolderUsage200Response
GetGhesConfig200Response
GetGitCommitHash200Response
GetGitSyncEnabled200Response
GetGithubAppToken200Response
GetGithubAppTokenRequest
GetGroupPermissionHistory200ResponseInner
GetHubAppById200Response
GetHubAppById200ResponseApp
GetHubFlowById200Response
GetHubScriptByPath200Response
GetIndexDiskStorageSizes200Response
GetIndexStorageSizes200Response
GetIndexStorageSizes200ResponseJobIndex
GetIndexerStatus200Response
GetIndexerStatus200ResponseJobIndexer
GetJobMetrics200Response
GetJobMetricsRequest
GetJobUpdates200Response
GetLatestKeyRenewalAttempt200Response
GetLogCleanupStatus200Response
GetMcpTools200ResponseInner
GetMinKeepAliveVersion200Response
GetNpmPackageFiletree200Response
GetNpmPackageFiletree200ResponseFilesInner
GetNpmPackageMetadata200Response
GetOAuthConnect200Response
GetObjectStorageUsage200Response
GetObjectStorageUsage200ResponseFoldersInner
GetPremiumInfo200Response
GetPublicAppByCustomPath200Response
GetPublicSettings200Response
GetQueueCount200Response
GetQueueMetrics200ResponseInner
GetQueueMetrics200ResponseInnerValuesInner
GetQueuePosition200Response
GetResumeUrls200Response
GetRunnable200Response
GetScriptDeploymentStatus200Response
GetSettings200Response
GetSharedUi200Response
GetSharedUiVersion200Response
GetStats200Response
GetSuspendedJobFlow200Response
GetThresholdAlert200Response
GetTopHubScripts200Response
GetTopHubScripts200ResponseAsksInner
GetTutorialProgress200Response
GetUsedTriggers200Response
GetWorkspaceDefaultApp200Response
GetWorkspaceEncryptionKey200Response
GetWorkspaceSlackOauthConfig200Response
GhesInstallationCallbackRequest
GitRepositorySettings
GitRepositorySettingsSettings
GithubInstallationsInner
GithubInstallationsInnerRepositoriesInner
GithubRepoEntry
GlobalOffboardPreview
GlobalOffboardRequest
GlobalSetting
GlobalUserInfo
GlobalUserRenameRequest
GlobalUserUpdateRequest
GlobalUsernameInfo200Response
GlobalUsernameInfo200ResponseWorkspaceUsernamesInner
GoogleCalendarEntry
GoogleDriveFile
GoogleDriveFilesResponse
Group
HealthChecks
HealthChecks : Detailed health checks
HealthStatusResponse
HealthStatusResponse : Health status response (cached with 5s TTL)
HttpTrigger
Identity
Identity : Pass-through module that returns its input unchanged. Useful for flow structure or as a placeholder
ImportInstallationRequest
ImportPgDatabaseRequest
InlineScriptArgs
Input
InstallFromWorkspaceRequest
InstanceAiProviderSummary
InstanceAiSummary
InstanceConfig
InstanceConfig : Unified instance configuration combining global settings and worker group configs
InstanceGroup
InstanceGroupWithWorkspaces
InviteUserRequest
JavascriptTransform
JavascriptTransform : JavaScript expression evaluated at runtime. Can reference previous step results via ‘results.step_id’ or flow inputs via ‘flow_input.property’. Inside loops, use ‘flow_input.iter.value’ for the current iteration value
JobOneOf
JobOneOf1
JobSearchHit
JwksResponse
KafkaTrigger
LargeFileStorage
LargeFileStorageSecondaryStorageValue
ListAllDedicatedWithDeps200ResponseInner
ListAllWorkspaceDependencies200ResponseInner
ListAssets200Response
ListAssets200ResponseAssetsInner
ListAssets200ResponseAssetsInnerMetadata
ListAssets200ResponseAssetsInnerUsagesInner
ListAssets200ResponseAssetsInnerUsagesInnerMetadata
ListAssets200ResponseNextCursor
ListAssets200ResponseNextCursor : Cursor for the next page (null if no more pages)
ListAssetsByUsage200ResponseInnerInner
ListAssetsByUsageRequest
ListAssetsByUsageRequestUsagesInner
ListAvailableTeamsChannels200Response
ListAvailableTeamsChannels200ResponseChannelsInner
ListAvailableTeamsIds200Response
ListAvailableTeamsIds200ResponseTeamsInner
ListBlacklistedAgentTokens200ResponseInner
ListDataTables200ResponseInner
ListDedicatedWithDeps200ResponseInner
ListFavoriteAssets200ResponseInner
ListFlows200ResponseInner
ListHubApps200Response
ListHubApps200ResponseAppsInner
ListHubFlows200Response
ListHubFlows200ResponseFlowsInner
ListHubIntegrations200ResponseInner
ListLogFiles200ResponseInner
ListOAuthLogins200Response
ListOAuthLogins200ResponseOauthInner
ListResourceNames200ResponseInner
ListSearchResource200ResponseInner
ListSearchScript200ResponseInner
ListSelectedJobGroups200ResponseInner
ListSelectedJobGroups200ResponseInnerSchemasInner
ListSharedUi200Response
ListStoredFiles200Response
ListWorkerGroups200ResponseInner
ListWsSpecific200ResponseInner
ListableApp
ListableRawApp
ListableResource
ListableVariable
LoadTableRowCount200Response
LogAiChatRequest
LogSearchHit
Login
LoginWithOauthRequest
MainArgSignature
MainArgSignatureArgsInner
MainArgSignatureArgsInnerTypOneOf
MainArgSignatureArgsInnerTypOneOf1
MainArgSignatureArgsInnerTypOneOf2
MainArgSignatureArgsInnerTypOneOf3
MainArgSignatureArgsInnerTypOneOf2Object
MainArgSignatureArgsInnerTypOneOf2ObjectPropsInner
MainArgSignatureArgsInnerTypOneOf2ObjectPropsInnerTypOneOf
McpToolValue
McpToolValue : Reference to an external MCP (Model Context Protocol) tool. The AI can call tools from MCP servers
MemoryAuto
MemoryAuto : Automatic context management
MemoryManual
MemoryManual : Explicit message history
MemoryMessage
MemoryMessage : A single message in conversation history
MemoryOff
MemoryOff : No conversation memory/context
MetricDataPoint
MetricMetadata
MoveCapturesAndConfigsRequest
MqttSubscribeTopic
MqttTrigger
MqttV3Config
MqttV5Config
NativeTrigger
NativeTrigger : A native trigger stored in Orvanta
NativeTriggerData
NativeTriggerData : Data for creating or updating a native trigger
NativeTriggerServiceCallbackRequest
NativeTriggerWithExternal
NativeTriggerWithExternal : Full trigger response containing both Orvanta data and external service data
NatsTrigger
NewEmailTrigger
NewHttpTrigger
NewHttpTriggerStaticAssetConfig
NewHttpTriggerStaticAssetConfig : Configuration for serving static assets (s3 bucket, storage path, filename)
NewKafkaTrigger
NewMqttTrigger
NewNatsTrigger
NewPostgresTrigger
NewSchedule
NewScript
NewScriptAssetsInner
NewScriptWithDraft
NewSqsTrigger
NewToken
NewTokenImpersonate
NewWebsocketTrigger
NewWebsocketTriggerFiltersInner
NewWorkspaceDependencies
NextCloudEventType
ObscuredJob
OffboardAffectedPaths
OffboardPreview
OffboardRequest
OffboardResponse
OffboardSummary
OffboardTokenInfo
OpenFlow
OpenFlow : Top-level flow definition containing metadata, configuration, and the flow structure
OpenFlowWPath
OpenapiHttpRouteFilters
OpenapiV3Info
OpenapiV3InfoContact
OpenapiV3InfoLicense
OperatorSettings
OrvantaFileMetadata
OrvantaFilePreview
OrvantaLargeFile
PasswordResetResponse
PathFlow
PathFlow : Reference to an existing flow by path. Use this to call another flow as a subflow
PathScript
PathScript : Reference to an existing script by path. Use this when calling a previously saved script instead of writing inline code
PickHubScriptByPath200Response
PolarsClientKwargs
PolarsConnectionSettings200Response
PolarsConnectionSettingsV2200Response
PolarsConnectionSettingsV2200ResponseStorageOptions
Policy
PolicyAllowedS3KeysInner
PoolStats
PoolStats : Database connection pool statistics
PostgresTrigger
Preview
PreviewInline
PreviewScheduleRequest
ProtectionRuleset
ProtectionRuleset : A workspace protection rule defining restrictions and bypass permissions
ProviderConfig
ProviderConfig : Complete AI provider configuration with resource reference and model selection
PruneVersions200Response
PruneVersionsRequest
PublicationData
PushConfig
PushConfig : Configuration for push delivery mode.
QueryDocumentationRequest
QueryHubScripts200ResponseInner
QueryResourceTypes200ResponseInner
QueueHealth
QueueHealth : Job queue status
QueuedJob
QuotaInfo
RawScript
RawScript : Inline script with code defined directly in the flow. Use ‘bun’ as default language if unspecified. The script receives arguments from input_transforms
RawScriptAssetsInner
RawScriptForDependencies
ReadinessHealth
ReadinessHealth : Server readiness status
RedirectUri
RefreshTokenRequest
Relations
RemoveBlacklistAgentTokenRequest
RemoveOwnerToFolderRequest
RequestPasswordResetRequest
ResetPasswordRequest
ResolveNpmPackageVersion200Response
Resource
ResourceType
RestartFlowAtStepRequest
RestartFlowAtStepRequestNestedPathInner
RestartedFrom
RestartedFromBranchChosen
RestartedFromBranchChosen : For BranchOne nested restart — the branch that was originally chosen, used to lock branch evaluation.
ResumeSuspendedRequest
ResumeSuspendedTriggerJobsRequest
Retry
Retry : Retry configuration for failed module executions
RetryConstant
RetryConstant : Retry with constant delay between attempts
RetryExponential
RetryExponential : Retry with exponential backoff (delay doubles each time)
RetryIf
RetryIf : Conditional retry based on error or result
RunFlowDependenciesAsyncRequest
RunRawScriptDependencies201Response
RunRawScriptDependenciesRequest
RunSlackMessageTestJob200Response
RunSlackMessageTestJobRequest
S3Object
S3PermissionRule
S3Resource
ScalarMetric
Schedule
ScheduleWJobs
ScheduleWJobsAllOfJobs
ScopeDefinition
ScopeDomain
Script
ScriptHistory
ScriptModule
ScriptModule : An additional module file associated with a script
SearchJobsIndex200Response
SearchJobsIndex200ResponseIndexMetadata
SearchJobsIndex200ResponseIndexMetadata : Metadata about the index current state
SearchLogsIndex200Response
SecretMigrationFailure
SecretMigrationReport
SendMessageToConversationRequest
SetCaptureConfigRequest
SetDefaultErrorOrRecoveryHandlerRequest
SetEnvironmentVariableRequest
SetGlobalRequest
SetHttpTriggerModeRequest
SetJobProgressRequest
SetLoginTypeForUserRequest
SetPasswordRequest
SetPublicAppRateLimitRequest
SetScheduleEnabledRequest
SetThresholdAlertRequest
SetWorkspaceEncryptionKeyRequest
SetWorkspaceSlackOauthConfigRequest
SetupCustomInstanceDbRequest
SharedDriveEntry
SignS3ObjectsRequest
SlackToken
SlackTokenTeam
Slot
SlotList
SqsTrigger
StarRequest
StaticMemoryTransform
StaticMemoryTransform : Static memory configuration passed directly to the AI agent
StaticProviderTransform
StaticProviderTransform : Static provider configuration passed directly to the AI agent
StaticTransform
StaticTransform : Static value passed directly to the step. Use for hardcoded values or resource references like ‘$res:path/to/resource’
StopAfterIf
StopAfterIf : Early termination condition for a module
SubmitOnboardingDataRequest
SuccessHandlerConfig
SuccessHandlerConfig : Configuration for the workspace success handler
SyncResult
TableToTrackInner
TeamInfo
TeamsChannel
TemplateScript
TestAzureConnection
TestCriticalChannelsRequestInner
TestKafkaConnectionRequest
TestLicenseKeyRequest
TestPostgresConnectionRequest
TestSmtpRequest
TestSmtpRequestSmtp
TestWebsocketConnectionRequest
TimeseriesMetric
ToggleWorkspaceErrorHandlerForScriptRequest
TokenResponse
TriggerExtraProperty
TriggersCount
TriggersCountPrimarySchedule
TruncatedToken
UpdateAppRequest
UpdateFlowHistoryRequest
UpdateFlowRequest
UpdateFolderRequest
UpdateGroupRequest
UpdateInput
UpdateInstanceGroupRequest
UpdateProtectionRuleRequest
UpdateScriptHistoryRequest
UpdateSharedUiRequest
UpdateTokenScopesRequest
UploadS3FileFromApp200Response
User
UserSource
UserUsage
UserWorkspaceList
UserWorkspaceListWorkspacesInner
VaultSettings
Volume
WebhookEvent
WebhookFilters
WebsearchToolValue
WebsearchToolValue : A tool implemented as a websearch tool. The AI can call this like any other websearch tool
WebsocketHeartbeat
WebsocketTrigger
WebsocketTriggerInitialMessage
WebsocketTriggerInitialMessageAnyOf
WebsocketTriggerInitialMessageAnyOf1
WebsocketTriggerInitialMessageAnyOf1RunnableResult
WhileloopFlow
WhileloopFlow : Executes nested modules repeatedly while a condition is true. The loop checks the condition after each iteration. Use stop_after_if on modules to control loop termination
WorkerPing
WorkersHealth
WorkersHealth : Workers health status
WorkflowStatus
WorkflowTask
Workspace
WorkspaceComparison
WorkspaceDefaultScripts
WorkspaceDependencies
WorkspaceDeployUiSettings
WorkspaceGitSyncSettings
WorkspaceGithubInstallation
WorkspaceInfo
WorkspaceIntegrations
WorkspaceInvite
WorkspaceItemDiff
WorkspaceMuteCriticalAlertsUiRequest
WorkspaceOAuthConfig
WorkspaceOffboardPreview
WorkspaceReassignment

Enums§

AiProvider
AiProviderKind
AiProviderKind : Supported AI provider types Supported AI provider types
AssetKind
AssetUsageAccessType
AssetUsageKind
AuthenticationMethod
AwsAuthResourceType
AzureMode
AzureMode : Azure Event Grid trigger mode. Azure Event Grid trigger mode.
CaptureTriggerKind
CustomInstanceDbTag
DeliveryType
DeliveryType : Delivery mode for messages. ‘push’ for HTTP push delivery where messages are sent to a webhook endpoint, ‘pull’ for polling where the trigger actively fetches messages. Delivery mode for messages. ‘push’ for HTTP push delivery where messages are sent to a webhook endpoint, ‘pull’ for polling where the trigger actively fetches messages.
DynamicInputDataRunnableRef
EditErrorHandler
EditErrorHandler : Request body for editing the workspace error handler. Accepts both new grouped format and legacy flat format for backward compatibility. Request body for editing the workspace error handler. Accepts both new grouped format and legacy flat format for backward compatibility.
EditSuccessHandler
EditSuccessHandler : Request body for editing the workspace success handler. Accepts both new grouped format and legacy flat format for backward compatibility. Request body for editing the workspace success handler. Accepts both new grouped format and legacy flat format for backward compatibility.
ErrorHandler
FlowModuleValue
FlowModuleValue : The actual implementation of a flow step. Can be a script (inline or referenced), subflow, loop, branch, or special module type
FlowStatusModuleAgentActionsInner
GitSyncObjectType
HttpMethod
HttpRequestType
HubScriptKind
InputTransform
InputTransform : Maps input parameters for a step. Can be a static value or a JavaScript expression that references previous results or flow inputs
Job
JobTriggerKind
JobTriggerKind : job trigger kind (schedule, http, websocket…) job trigger kind (schedule, http, websocket…)
Language
LoggedWizardStatus
MainArgSignatureArgsInnerTyp
MainArgSignatureArgsInnerTypOneOf2ObjectPropsInnerTyp
MainArgSignatureArgsInnerTypOneOf3List
MemoryConfig
MemoryConfig : Conversation memory configuration
MemoryTransform
MemoryTransform : Memory configuration - can be static (MemoryConfig), JavaScript expression, or AI-determined
MqttClientVersion
MqttQoS
NativeServiceName
OpenapiSpecFormat
ProtectionRuleKind
ProviderTransform
ProviderTransform : Provider configuration - can be static (ProviderConfig), JavaScript expression, or AI-determined
RunnableKind
RunnableType
ScriptLang
SubscriptionMode
SubscriptionMode : The mode of subscription. ‘existing’ means using an existing GCP subscription, while ‘create_update’ involves creating or updating a new subscription. The mode of subscription. ‘existing’ means using an existing GCP subscription, while ‘create_update’ involves creating or updating a new subscription.
ToolValue
ToolValue : The implementation of a tool. Can be a flow module (script/flow) or an MCP tool reference
TriggerMode
TriggerMode : job trigger mode job trigger mode
WebhookRequestType
WebhookRequestType : The type of webhook request (define possible values here) The type of webhook request (define possible values here)