Static deleteThe data for the request.
-string delete user
-ApiError
-Static getget user (require admin privilege)
-The data for the request.
-User user created
-ApiError
-Static updateupdate user (require admin privilege)
-The data for the request.
-string edited user
-ApiError
-Static captureReadonly bodyReadonly requestOptional stackReadonly statusReadonly statusReadonly urlStatic Optional prepareOptional override for formatting stack traces
-Static stackStatic createcreate app
-The data for the request.
-string app created
-ApiError
-Static deletedelete app
-The data for the request.
-string app deleted
-ApiError
-Static executeexecuteComponent
-The data for the request.
-string job uuid
-ApiError
-Static existsdoes an app exisst at path
-The data for the request.
-boolean app exists
-ApiError
-Static getget app by path
-The data for the request.
-AppWithLastVersion app details
-ApiError
-Static getget app by path with draft
-The data for the request.
-AppWithLastVersionWDraft app details with draft
-ApiError
-Static getget app by version
-The data for the request.
-AppWithLastVersion app details
-ApiError
-Static getget app history by path
-The data for the request.
-AppHistory app history
-ApiError
-Static getget hub app by id
-The data for the request.
-unknown app
-ApiError
-Static getget public app by secret
-The data for the request.
-AppWithLastVersion app details
-ApiError
-Static getget public resource
-The data for the request.
-unknown resource value
-ApiError
-Static getget public secret of app
-The data for the request.
-string app secret
-ApiError
-Static listlist all apps
-The data for the request.
-ListableApp All apps
-ApiError
-Static listlist all hub apps
-unknown hub apps list
-ApiError
-Static listlist apps for search
-The data for the request.
-unknown app list
-ApiError
-Static updateupdate app
-The data for the request.
-string app updated
-ApiError
-Static updateupdate app history
-The data for the request.
-string success
-ApiError
-Static getget audit log (requires admin privilege)
-The data for the request.
-AuditLog an audit log
-ApiError
-Static listlist audit logs (requires admin privilege)
-The data for the request.
-AuditLog a list of audit logs
-ApiError
-Static captureOptional stackStatic Optional prepareOptional override for formatting stack traces
-Static stackOptional reason: unknownPrivate _isPrivate _isPrivate _isPrivate Optional _rejectOptional reason: unknownPrivate Optional _resolveReadonly cancelReadonly promiseStatic createcreate flow preview capture
-The data for the request.
-unknown flow preview capture created
-ApiError
-Static getget flow preview capture
-The data for the request.
-unknown captured flow preview
-ApiError
-Static updateupdate flow preview capture
-The data for the request.
-void flow preview captured
-ApiError
-Static deleteDelete concurrency group
-The data for the request.
-unknown concurrency group removed
-ApiError
-Static getGet the concurrency key for a job that has concurrency limits enabled
-The data for the request.
-string concurrency key for given job
-ApiError
-Static listList all concurrency groups
-ConcurrencyGroup all concurrency groups
-ApiError
-Static listGet intervals of job runtime concurrency
-The data for the request.
-ExtendedJobs time
-ApiError
-Static deleteDelete Config
-The data for the request.
-string Delete config
-ApiError
-Static getget config
-The data for the request.
-unknown a config
-ApiError
-Static listlist worker groups
-unknown a list of worker group configs
-ApiError
-Static updateUpdate config
-The data for the request.
-string Update a worker group
-ApiError
-Static createcreate draft
-The data for the request.
-string draft created
-ApiError
-Static deletedelete draft
-The data for the request.
-string draft deleted
-ApiError
-Static starstar item
-The data for the request.
-unknown star item
-ApiError
-Static unstarunstar item
-The data for the request.
-unknown unstar item
-ApiError
-Static archivearchive flow by path
-The data for the request.
-string flow archived
-ApiError
-Static createcreate flow
-The data for the request.
-string flow created
-ApiError
-Static deletedelete flow by path
-The data for the request.
-string flow delete
-ApiError
-Static existsexists flow by path
-The data for the request.
-boolean flow details
-ApiError
-Static getget flow by path
-The data for the request.
-Flow flow details
-ApiError
-Static getget flow by path with draft
-The data for the request.
-unknown flow details with draft
-ApiError
-Static getlist inputs for previous completed flow jobs
-The data for the request.
-Input input history for completed jobs with this flow path
-ApiError
-Static getget hub flow by id
-The data for the request.
-unknown flow
-ApiError
-Static listlist all flow paths
-The data for the request.
-string list of flow paths
-ApiError
-Static listlist all flows
-The data for the request.
-unknown All flow
-ApiError
-Static listlist all hub flows
-unknown hub flows list
-ApiError
-Static listlist flows for search
-The data for the request.
-unknown flow list
-ApiError
-Static toggleToggle ON and OFF the workspace error handler for a given flow
-The data for the request.
-string error handler toggled
-ApiError
-Static updateupdate flow
-The data for the request.
-string flow updated
-ApiError
-Static addadd owner to folder
-The data for the request.
-string owner added to folder
-ApiError
-Static createcreate folder
-The data for the request.
-string folder created
-ApiError
-Static deletedelete folder
-The data for the request.
-string folder deleted
-ApiError
-Static getget folder
-The data for the request.
-Folder folder
-ApiError
-Static getget folder usage
-The data for the request.
-unknown folder
-ApiError
-Static listlist folder names
-The data for the request.
-string folder list
-ApiError
-Static listlist folders
-The data for the request.
-Folder folder list
-ApiError
-Static removeremove owner to folder
-The data for the request.
-string owner removed from folder
-ApiError
-Static updateupdate folder
-The data for the request.
-string folder updated
-ApiError
-Static addadd granular acls
-The data for the request.
-string granular acl added
-ApiError
-Static getget granular acls
-The data for the request.
-boolean acls
-ApiError
-Static removeremove granular acls
-The data for the request.
-string granular acl removed
-ApiError
-Static addadd user to group
-The data for the request.
-string user added to group
-ApiError
-Static addadd user to instance group
-The data for the request.
-string user added to instance group
-ApiError
-Static createcreate group
-The data for the request.
-string group created
-ApiError
-Static createcreate instance group
-The data for the request.
-string instance group created
-ApiError
-Static deletedelete group
-The data for the request.
-string group deleted
-ApiError
-Static deletedelete instance group
-The data for the request.
-string instance group deleted
-ApiError
-Static getget group
-The data for the request.
-Group group
-ApiError
-Static getget instance group
-The data for the request.
-InstanceGroup instance group
-ApiError
-Static listlist group names
-The data for the request.
-string group list
-ApiError
-Static listlist groups
-The data for the request.
-Group group list
-ApiError
-Static listlist instance groups
-InstanceGroup instance group list
-ApiError
-Static removeremove user from instance group
-The data for the request.
-string user removed from instance group
-ApiError
-Static removeremove user to group
-The data for the request.
-string user removed from group
-ApiError
-Static updateupdate group
-The data for the request.
-string group updated
-ApiError
-Static updateupdate instance group
-The data for the request.
-string instance group updated
-ApiError
-Static datasetTest connection to the workspace object storage
-The data for the request.
-unknown Connection settings
-ApiError
-Static deletePermanently delete file from S3
-The data for the request.
-unknown Confirmation
-ApiError
-Static duckdbConverts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
-The data for the request.
-unknown Connection settings
-ApiError
-Static duckdbConverts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
-The data for the request.
-unknown Connection settings
-ApiError
-Static fileDownload file to S3 bucket
-The data for the request.
-binary Chunk of the downloaded file
-ApiError
-Static fileDownload file to S3 bucket
-The data for the request.
-string The downloaded file
-ApiError
-Static fileUpload file to S3 bucket
-The data for the request.
-unknown File upload status
-ApiError
-Static listList the file keys available in a workspace object storage
-The data for the request.
-unknown List of file keys
-ApiError
-Static loadLoad a preview of a csv file
-The data for the request.
-unknown Csv Preview
-ApiError
-Static loadLoad metadata of the file
-The data for the request.
-WindmillFileMetadata FileMetadata
-ApiError
-Static loadLoad a preview of the file
-The data for the request.
-WindmillFilePreview FilePreview
-ApiError
-Static loadLoad a preview of a parquet file
-The data for the request.
-unknown Parquet Preview
-ApiError
-Static moveMove a S3 file from one path to the other within the same bucket
-The data for the request.
-unknown Confirmation
-ApiError
-Static polarsConverts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
-The data for the request.
-unknown Connection settings
-ApiError
-Static polarsConverts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
-The data for the request.
-unknown Connection settings
-ApiError
-Static s3Returns the s3 resource associated to the provided path, or the workspace default S3 resource
-The data for the request.
-S3Resource Connection settings
-ApiError
-Static createCreate an Input for future use in a script or flow
-The data for the request.
-string Input created
-ApiError
-Static deleteDelete a Saved Input
-The data for the request.
-string Input deleted
-ApiError
-Static getGet args from history or saved input
-The data for the request.
-unknown args
-ApiError
-Static getList Inputs used in previously completed jobs
-The data for the request.
-Input Input history for completed jobs
-ApiError
-Static listList saved Inputs for a Runnable
-The data for the request.
-Input Saved Inputs for a Runnable
-ApiError
-Static updateUpdate an Input
-The data for the request.
-string Input updated
-ApiError
-Static listlist hub integrations
-The data for the request.
-unknown integrations details
-ApiError
-Static cancelcancel all jobs
-The data for the request.
-string uuids of canceled jobs
-ApiError
-Static cancelcancel all queued jobs for persistent script
-The data for the request.
-string persistent job scaled down to zero
-ApiError
-Static cancelcancel queued job
-The data for the request.
-string job canceled
-ApiError
-Static cancelcancel a job for a suspended flow
-The data for the request.
-string job canceled
-ApiError
-Static cancelcancel a job for a suspended flow
-The data for the request.
-string job canceled
-ApiError
-Static createcreate an HMac signature given a job id and a resume id
-The data for the request.
-string job signature
-ApiError
-Static deletedelete completed job (erase content but keep run id)
-The data for the request.
-CompletedJob job details
-ApiError
-Static forceforce cancel queued job
-The data for the request.
-string job canceled
-ApiError
-Static getget completed count
-The data for the request.
-unknown completed count
-ApiError
-Static getget completed job
-The data for the request.
-CompletedJob job details
-ApiError
-Static getget completed job result
-The data for the request.
-unknown result
-ApiError
-Static getget completed job result if job is completed
-The data for the request.
-unknown result
-ApiError
-Static getget db clock
-number the timestamp of the db that can be used to compute the drift
-ApiError
-Static getget flow debug info
-The data for the request.
-unknown flow debug info details
-ApiError
-Static getget flow user state at a given key
-The data for the request.
-unknown flow user state updated
-ApiError
-Static getget job
-The data for the request.
-Job job details
-ApiError
-Static getget job logs
-The data for the request.
-string job details
-ApiError
-Static getget job updates
-The data for the request.
-unknown job details
-ApiError
-Static getget log file from object store
-The data for the request.
-unknown job log
-ApiError
-Static getget queue count
-The data for the request.
-unknown queue count
-ApiError
-Static getget resume urls given a job_id, resume_id and a nonce to resume a flow
-The data for the request.
-unknown url endpoints
-ApiError
-Static getget root job id
-The data for the request.
-string get root job id
-ApiError
-Static getget parent flow job of suspended job
-The data for the request.
-unknown parent flow details
-ApiError
-Static listlist all completed jobs
-The data for the request.
-CompletedJob All completed jobs
-ApiError
-Static listGet intervals of job runtime concurrency
-The data for the request.
-ExtendedJobs time
-ApiError
-Static listlist all jobs
-The data for the request.
-Job All jobs
-ApiError
-Static listlist all queued jobs
-The data for the request.
-QueuedJob All queued jobs
-ApiError
-Static openairun flow by path and wait until completion in openai format
-The data for the request.
-unknown job result
-ApiError
-Static openairun script by path in openai format
-The data for the request.
-unknown job result
-ApiError
-Static restartrestart a completed flow at a given step
-The data for the request.
-string job created
-ApiError
-Static resultget job result by id
-The data for the request.
-unknown job result
-ApiError
-Static resumeresume a job for a suspended flow as an owner
-The data for the request.
-string job resumed
-ApiError
-Static resumeresume a job for a suspended flow
-The data for the request.
-string job resumed
-ApiError
-Static resumeresume a job for a suspended flow
-The data for the request.
-string job resumed
-ApiError
-Static runrun code-workflow task
-The data for the request.
-string job created
-ApiError
-Static runrun flow by path
-The data for the request.
-string job created
-ApiError
-Static runrun flow preview
-The data for the request.
-string job created
-ApiError
-Static runrun a one-off dependencies job
-The data for the request.
-unknown dependency job result
-ApiError
-Static runrun script by hash
-The data for the request.
-string job created
-ApiError
-Static runrun script by path
-The data for the request.
-string job created
-ApiError
-Static runrun script preview
-The data for the request.
-string job created
-ApiError
-Static runrun flow by path and wait until completion
-The data for the request.
-unknown job result
-ApiError
-Static runrun script by path
-The data for the request.
-unknown job result
-ApiError
-Static runrun script by path with get
-The data for the request.
-unknown job result
-ApiError
-Static setset flow user state at a given key
-The data for the request.
-string flow user state updated
-ApiError
-Static getget job metrics
-The data for the request.
-unknown job details
-ApiError
-Static connectconnect callback
-The data for the request.
-TokenResponse oauth token
-ApiError
-Static connectconnect slack callback
-The data for the request.
-string slack token
-ApiError
-Static createcreate OAuth account
-The data for the request.
-string account set
-ApiError
-Static disconnectdisconnect account
-The data for the request.
-string disconnected client
-ApiError
-Static disconnectdisconnect slack
-The data for the request.
-string disconnected slack
-ApiError
-Static getget oauth connect
-The data for the request.
-unknown get
-ApiError
-Static listlist oauth connects
-string list of oauth connects clients
-ApiError
-Static listlist oauth logins
-unknown list of oauth and saml login clients
-ApiError
-Static refreshrefresh token
-The data for the request.
-string token refreshed
-ApiError
-Static getget OIDC token (ee only)
-The data for the request.
-string new oidc token
-ApiError
-Static createcreate raw app
-The data for the request.
-string raw app created
-ApiError
-Static deletedelete raw app
-The data for the request.
-string app deleted
-ApiError
-Static existsdoes an app exisst at path
-The data for the request.
-boolean app exists
-ApiError
-Static getget app by path
-The data for the request.
-string app details
-ApiError
-Static listlist all raw apps
-The data for the request.
-ListableRawApp All raw apps
-ApiError
-Static updateupdate app
-The data for the request.
-string app updated
-ApiError
-Static createcreate resource
-The data for the request.
-string resource created
-ApiError
-Static createcreate resource_type
-The data for the request.
-string resource_type created
-ApiError
-Static deletedelete resource
-The data for the request.
-string resource deleted
-ApiError
-Static deletedelete resource_type
-The data for the request.
-string resource_type deleted
-ApiError
-Static existsdoes resource exists
-The data for the request.
-boolean does resource exists
-ApiError
-Static existsdoes resource_type exists
-The data for the request.
-boolean does resource_type exist
-ApiError
-Static getget resource
-The data for the request.
-Resource resource
-ApiError
-Static getget resource_type
-The data for the request.
-ResourceType resource_type deleted
-ApiError
-Static getget resource value
-The data for the request.
-unknown resource value
-ApiError
-Static getget resource interpolated (variables and resources are fully unrolled)
-The data for the request.
-unknown resource value
-ApiError
-Static listlist resources
-The data for the request.
-ListableResource resource list
-ApiError
-Static listlist resource names
-The data for the request.
-unknown resource list names
-ApiError
-Static listlist resource_types
-The data for the request.
-ResourceType resource_type list
-ApiError
-Static listlist resource_types names
-The data for the request.
-string resource_type list
-ApiError
-Static listlist resources for search
-The data for the request.
-unknown resource list
-ApiError
-Static queryquery resource types by similarity
-The data for the request.
-unknown resource type details
-ApiError
-Static updateupdate resource
-The data for the request.
-string resource updated
-ApiError
-Static updateupdate resource_type
-The data for the request.
-string resource_type updated
-ApiError
-Static updateupdate resource value
-The data for the request.
-string resource value updated
-ApiError
-Static createcreate schedule
-The data for the request.
-string schedule created
-ApiError
-Static deletedelete schedule
-The data for the request.
-string schedule deleted
-ApiError
-Static existsdoes schedule exists
-The data for the request.
-boolean schedule exists
-ApiError
-Static getget schedule
-The data for the request.
-Schedule schedule deleted
-ApiError
-Static listlist schedules
-The data for the request.
-Schedule schedule list
-ApiError
-Static listlist schedules with last 20 jobs
-The data for the request.
-ScheduleWJobs schedule list
-ApiError
-Static previewpreview schedule
-The data for the request.
-string List of 5 estimated upcoming execution events (in UTC)
-ApiError
-Static setSet default error or recoevery handler
-The data for the request.
-unknown default error handler set
-ApiError
-Static setset enabled schedule
-The data for the request.
-string schedule enabled set
-ApiError
-Static updateupdate schedule
-The data for the request.
-string schedule updated
-ApiError
-Static archivearchive script by hash
-The data for the request.
-Script script details
-ApiError
-Static archivearchive script by path
-The data for the request.
-string script archived
-ApiError
-Static createcreate script
-The data for the request.
-string script created
-ApiError
-Static deletedelete script by hash (erase content but keep hash, require admin)
-The data for the request.
-Script script details
-ApiError
-Static deletedelete all scripts at a given path (require admin)
-The data for the request.
-string script path
-ApiError
-Static existsexists script by path
-The data for the request.
-boolean does it exists
-ApiError
-Static getget full hub script by path
-The data for the request.
-unknown script details
-ApiError
-Static getget hub script content by path
-The data for the request.
-string script details
-ApiError
-Static getget script by hash
-The data for the request.
-Script script details
-ApiError
-Static getget script by path
-The data for the request.
-Script script details
-ApiError
-Static getget script by path with draft
-The data for the request.
-NewScriptWithDraft script details
-ApiError
-Static getget script deployment status
-The data for the request.
-unknown script details
-ApiError
-Static getget history of a script by path
-The data for the request.
-ScriptHistory script history
-ApiError
-Static getget top hub scripts
-The data for the request.
-unknown hub scripts list
-ApiError
-Static listlist all scripts paths
-The data for the request.
-string list of script paths
-ApiError
-Static listlist all scripts
-The data for the request.
-Script All scripts
-ApiError
-Static listlist scripts for search
-The data for the request.
-unknown script list
-ApiError
-Static queryquery hub scripts by similarity
-The data for the request.
-unknown script details
-ApiError
-Static rawraw script by hash
-The data for the request.
-string script content
-ApiError
-Static rawraw script by path
-The data for the request.
-string script content
-ApiError
-Static rawraw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
-The data for the request.
-string script content
-ApiError
-Static toggleToggle ON and OFF the workspace error handler for a given script
-The data for the request.
-string error handler toggled
-ApiError
-Static updateupdate history of a script
-The data for the request.
-string success
-ApiError
-Static getget global settings
-The data for the request.
-unknown status
-ApiError
-Static getget latest key renewal attempt
-unknown status
-ApiError
-Static getget local settings
-unknown status
-ApiError
-Static renewrenew license key
-string status
-ApiError
-Static sendsend stats
-string status
-ApiError
-Static setpost global settings
-The data for the request.
-string status
-ApiError
-Static testtest license key
-The data for the request.
-string status
-ApiError
-Static testtest metadata
-The data for the request.
-string status
-ApiError
-Static testtest object storage config
-The data for the request.
-string status
-ApiError
-Static testtest smtp
-The data for the request.
-string status
-ApiError
-Static backendis backend up to date
-string is backend up to date
-ApiError
-Static backendget backend version
-string git version of backend
-ApiError
-Static getget license id
-string get license id (empty if not ee)
-ApiError
-Static getget openapi yaml spec
-string openapi yaml file content
-ApiError
-Static acceptaccept invite to workspace
-The data for the request.
-string status
-ApiError
-Static createcreate token
-The data for the request.
-string token created
-ApiError
-Static createcreate token to impersonate a user (require superadmin)
-The data for the request.
-string token created
-ApiError
-Static createcreate user
-The data for the request.
-string user created
-ApiError
-Static declinedecline invite to workspace
-The data for the request.
-string status
-ApiError
-Static deletedelete token
-The data for the request.
-string delete token
-ApiError
-Static deletedelete user (require admin privilege)
-The data for the request.
-string delete user
-ApiError
-Static existsexists email
-The data for the request.
-boolean user
-ApiError
-Static getget current user email (if logged in)
-string user email
-ApiError
-Static getget all runnables in every workspace
-unknown free all runnables
-ApiError
-Static getget tutorial progress
-unknown tutorial progress
-ApiError
-Static getget current usage outside of premium workspaces
-number free usage
-ApiError
-Static getget user (require admin privilege)
-The data for the request.
-User user created
-ApiError
-Static globalglobal delete user (require super admin)
-The data for the request.
-string user deleted
-ApiError
-Static globalglobal rename user (require super admin)
-The data for the request.
-string user renamed
-ApiError
-Static globalglobal update user (require super admin)
-The data for the request.
-string user updated
-ApiError
-Static globalglobal username info (require super admin)
-The data for the request.
-unknown user renamed
-ApiError
-Static globalget current global whoami (if logged in)
-GlobalUserInfo user email
-ApiError
-Static isis owner of path
-The data for the request.
-boolean is owner
-ApiError
-Static leaveleave instance
-string status
-ApiError
-Static listlist token
-The data for the request.
-TruncatedToken truncated token
-ApiError
-Static listlist usernames
-The data for the request.
-string user
-ApiError
-Static listlist users
-The data for the request.
-User user
-ApiError
-Static listlist all users as super admin (require to be super amdin)
-The data for the request.
-GlobalUserInfo user
-ApiError
-Static listlist users usage
-The data for the request.
-UserUsage user
-ApiError
-Static listlist all workspace invites
-WorkspaceInvite list all workspace invites
-ApiError
-Static loginlogin with password
-The data for the request.
-string Successfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
ApiError
-Static loginlogin with oauth authorization flow
-The data for the request.
-string Successfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
ApiError
-Static logoutlogout
-string clear cookies and clear token (if applicable)
-ApiError
-Static refreshrefresh the current token
-string free usage
-ApiError
-Static setset password
-The data for the request.
-string password set
-ApiError
-Static updateupdate tutorial progress
-The data for the request.
-string tutorial progress
-ApiError
-Static updateupdate user (require admin privilege)
-The data for the request.
-string edited user
-ApiError
-Static usernameget email from username
-The data for the request.
-string email
-ApiError
-Static whoamiwhoami
-The data for the request.
-User user
-ApiError
-Static whoiswhois
-The data for the request.
-User user
-ApiError
-Static createcreate variable
-The data for the request.
-string variable created
-ApiError
-Static deletedelete variable
-The data for the request.
-string variable deleted
-ApiError
-Static encryptencrypt value
-The data for the request.
-string encrypted value
-ApiError
-Static existsdoes variable exists at path
-The data for the request.
-boolean variable
-ApiError
-Static getget variable
-The data for the request.
-ListableVariable variable
-ApiError
-Static getget variable value
-The data for the request.
-string variable
-ApiError
-Static listlist contextual variables
-The data for the request.
-ContextualVariable contextual variable list
-ApiError
-Static listlist variables
-The data for the request.
-ListableVariable variable list
-ApiError
-Static updateupdate variable
-The data for the request.
-string variable updated
-ApiError
-Static existsexists worker with tag
-The data for the request.
-boolean whether a worker with the tag exists
-ApiError
-Static geget all instance default tags
-string list of default tags
-ApiError
-Static getget all instance custom tags (tags are used to dispatch jobs to different worker groups)
-string list of custom tags
-ApiError
-Static getget queue metrics
-unknown metrics
-ApiError
-Static isis default tags per workspace
-boolean is the default tags per workspace
-ApiError
-Static listlist workers
-The data for the request.
-WorkerPing a list of workers
-ApiError
-Static addadd user to workspace
-The data for the request.
-string status
-ApiError
-Static archivearchive workspace
-The data for the request.
-string status
-ApiError
-Static changechange workspace id
-The data for the request.
-string status
-ApiError
-Static changechange workspace name
-The data for the request.
-string status
-ApiError
-Static createcreate workspace
-The data for the request.
-string token created
-ApiError
-Static deletedelete user invite
-The data for the request.
-string status
-ApiError
-Static deletedelete workspace (require super admin)
-The data for the request.
-string status
-ApiError
-Static editedit auto invite
-The data for the request.
-string status
-ApiError
-Static editedit copilot config
-The data for the request.
-string status
-ApiError
-Static editedit default scripts for workspace
-The data for the request.
-string status
-ApiError
-Static editedit deploy to
-The data for the request.
-string status
-ApiError
-Static editedit error handler
-The data for the request.
-string status
-ApiError
-Static editedit large file storage settings
-The data for the request.
-unknown status
-ApiError
-Static editedit slack command
-The data for the request.
-string status
-ApiError
-Static editedit webhook
-The data for the request.
-string status
-ApiError
-Static editedit default app for workspace
-The data for the request.
-string status
-ApiError
-Static editedit workspace git sync settings
-The data for the request.
-unknown status
-ApiError
-Static existsexists username
-The data for the request.
-boolean status
-ApiError
-Static existsexists workspace
-The data for the request.
-boolean status
-ApiError
-Static getget copilot info
-The data for the request.
-unknown status
-ApiError
-Static getget default scripts for workspace
-The data for the request.
-WorkspaceDefaultScripts status
-ApiError
-Static getget deploy to
-The data for the request.
-unknown status
-ApiError
-Static getget if workspace is premium
-The data for the request.
-boolean status
-ApiError
-Static getget large file storage config
-The data for the request.
-LargeFileStorage status
-ApiError
-Static getget premium info
-The data for the request.
-unknown status
-ApiError
-Static getget settings
-The data for the request.
-unknown status
-ApiError
-Static getget default app for workspace
-The data for the request.
-unknown status
-ApiError
-Static getretrieves the encryption key for this workspace
-The data for the request.
-unknown status
-ApiError
-Static getget workspace name
-The data for the request.
-string status
-ApiError
-Static getget usage
-The data for the request.
-number usage
-ApiError
-Static inviteinvite user to workspace
-The data for the request.
-string status
-ApiError
-Static isis domain allowed for auto invi
-boolean domain allowed or not
-ApiError
-Static leaveleave workspace
-The data for the request.
-string status
-ApiError
-Static listlist pending invites for a workspace
-The data for the request.
-WorkspaceInvite user
-ApiError
-Static listlist all workspaces visible to me with user info
-UserWorkspaceList workspace with associated username
-ApiError
-Static listlist all workspaces visible to me
-Workspace all workspaces
-ApiError
-Static listlist all workspaces as super admin (require to be super admin)
-The data for the request.
-Workspace workspaces
-ApiError
-Static runrun a job that sends a message to Slack
-The data for the request.
-unknown status
-ApiError
-Static setset automatic billing
-The data for the request.
-string status
-ApiError
-Static setset environment variable
-The data for the request.
-string status
-ApiError
-Static setupdate the encryption key for this workspace
-The data for the request.
-string status
-ApiError
-Static unarchiveunarchive workspace
-The data for the request.
-string status
-ApiError
-Get a resource value by path
-Optional path: stringpath of the resource, default to internal state path
-Optional undefinedIfEmpty: booleanif the resource does not exist, return undefined instead of throwing an error
-resource value
-Get URLs needed for resuming a flow after this step
-Optional approver: stringapprover name
-approval page UI URL, resume and cancel API URLs for resuming the flow
-Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
-let fileContent = await wmill.loadS3FileContent(inputFile)
// if the file is a raw text file, it can be decoded and printed directly:
const text = new TextDecoder().decode(fileContentStream)
console.log(text);
-
-Load the content of a file stored in S3 as a stream. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
-let fileContentBlob = await wmill.loadS3FileStream(inputFile)
// if the content is plain text, the blob can be read directly:
console.log(await fileContentBlob.text());
-
-Set a resource value by path
-new value of the resource to set
-Optional path: stringpath of the resource to set, default to state path
-Optional initializeToTypeIfNotExist: stringif the resource does not exist, initialize it with this type
-Set a variable by path, create if not exist
-path of the variable
-value of the variable
-Optional isSecretIfNotExist: booleanif the variable does not exist, create it as secret or not (default: false)
-Optional descriptionIfNotExist: stringif the variable does not exist, create it with this description (default: "")
-Get email from workspace username -This method is particularly useful for apps that require the email address of the viewer. -Indeed, in the viewer context, WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.
-email address
-Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
-const s3object = await writeS3File(s3Object, "Hello Windmill!")
const fileContentAsUtf8Str = (await s3object.toArray()).toString('utf-8')
console.log(fileContentAsUtf8Str)
-
-The SDK for the Windmill API.
-import * as wmill from 'windmill-client';
await wmill.getVariable('u/foo/my_variable')
-
-accept invite
-Optional username?: stringacl to add
-Optional write?: booleanowner user to folder
-WorkspaceInvite
-Optional username?: stringadded user to group
-Optional username?: stringuser to add to instance group
-Optional deployment_Optional draft?: unknownOptional draft_archiveFlow
-Optional archived?: booleanOptional parameters?: { Optional resource?: stringOptional parallel?: booleanreason
-Optional reason?: stringreason
-Optional reason?: stringOptional approver?: stringOptional approver?: stringOptional requestOptional new_Optional new_Optional requestOptional new_Optional args?: ScriptArgsOptional canceled_Optional canceled_Optional deleted?: booleanOptional flow_Optional labels?: string[]Optional language?: "python3" | "deno" | "go" | "bash" | "powershell" | "postgresql" | "mysql" | "bigquery" | "snowflake" | "mssql" | "graphql" | "nativets" | "bun" | "php"Optional logs?: stringOptional mem_Optional parent_The user (u/userfoo) or group (g/groupfoo) whom -the execution of this script will be permissioned_as and by extension its DT_TOKEN.
-Optional priority?: numberOptional raw_Optional raw_Optional result?: unknownOptional schedule_Optional script_Optional script_Optional workspace_code endpoint
-code endpoint
-code endpoint
-Optional refresh_Optional value?: unknownPartially filled flow
-create folder
-Optional extra_Optional owners?: string[]create group
-Optional summary?: stringInput
-Optional runnableOptional runnablecreate instance group
-Optional summary?: stringOptional approver?: stringnew raw app
-Optional description?: stringnew resource
-Optional updatenew resource_type
-new schedule
-new token
-user info
-Optional company?: stringOptional name?: stringOptional account?: numberOptional is_Optional alreadynew variable
-Optional username?: stringnew token
-Optional storage?: stringdecline invite
-WorkspaceInvite
-Optional storage?: stringOptional accessOptional bucket?: stringOptional pathOptional secretOptional useSSL?: booleanS3 resource to connect to
-Optional s3_Optional connection_S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_WorkspaceInvite
-Optional auto_Optional invite_Optional operator?: booleanWorkspaceCopilotConfig
-Optional openai_Optional requestWorkspace default app
-Optional deploy_WorkspaceErrorHandler
-Optional error_Optional error_Optional error_LargeFileStorage info
-Optional large_Optional description?: stringOptional path?: stringOptional value?: unknownOptional description?: stringOptional schema?: unknownOptional no_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional retry?: RetryOptional summary?: stringOptional tag?: stringOptional ws_WorkspaceInvite
-Optional slack_Optional description?: stringOptional is_Optional path?: stringOptional value?: stringWorkspaceWebhook
-Optional webhook?: stringWorkspace default app
-Optional default_Workspace Git sync settings
-Optional git_Optional disabled?: booleanOptional is_Optional operator?: booleannew variable
-update app
-Optional force_Optional force_Optional force_Optional path?: stringOptional raw_Optional cache_Optional lock?: stringOptional path?: stringid of workspace
-Optional omitted_Obscured jobs omitted for security because of too specific filtering
-Optional resourceOptional s3Optional storage?: stringOptional resourceOptional s3Optional fileOptional fileFile content
-Optional resourceOptional s3Optional storage?: stringOptional dedicated_Optional draft_Optional priority?: numberOptional starred?: booleanOptional tag?: stringOptional timeout?: numberOptional visible_Optional workspace_Optional ws_Optional cache_Optional continue_Optional delete_Optional mock?: { Optional enabled?: booleanOptional return_Optional priority?: numberOptional retry?: RetryOptional sleep?: InputTransformOptional stop_Optional skip_Optional summary?: stringOptional suspend?: { Optional hide_Optional required_Optional resume_Optional schema?: { Optional self_Optional timeout?: numberOptional user_Optional user_Optional timeout?: numberOptional path?: stringOptional restarted_Optional tag?: stringOptional retry?: { Optional fail_Optional failed_Optional user_Optional approvers?: { Optional branch_Optional branch?: numberOptional branchall?: { Optional count?: numberOptional failed_Optional flow_Optional id?: stringOptional iterator?: { Optional args?: unknownOptional index?: numberOptional itered?: unknown[]Optional job?: stringOptional cache_Optional concurrency_Optional concurrency_Optional concurrent_Optional early_Optional failure_Optional priority?: numberOptional same_Optional skip_reason
-Optional reason?: stringOptional parallel?: booleanOptional parallelism?: numberOptional getOptional started?: booleanOptional success?: booleanOptional deploy_Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional lockfile?: stringOptional schema?: unknownOptional summary?: stringOptional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional runnableOptional runnableOptional noparameters for statistics retrieval
-Optional from_Optional timeseries_Optional to_Optional metrics_Optional scalar_Optional timeseries_Optional logOptional running?: booleanOptional completed?: booleanOptional flow_Optional log_Optional mem_Optional new_Optional running?: booleanclient name
-Optional extra_Optional scopes?: string[]Optional seats?: numberOptional usage?: numberOptional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional jobjob id
-Optional approver?: stringOptional description?: stringOptional lock?: stringOptional lock_Optional auto_Optional auto_Optional auto_Optional customer_Optional default_Optional default_Optional deploy_Optional error_Optional error_Optional git_Optional large_Optional openai_Optional plan?: stringOptional slack_Optional slack_Optional slack_Optional webhook?: stringOptional workspace_Optional approver?: stringOptional app?: stringquery scripts app
-Optional kind?: stringquery scripts kind
-Optional limit?: numberquery limit
-Optional asks?: { Optional progress?: numberOptional decryptask to decrypt secret if this variable is secret -(if not secret no effect, default: true)
-Optional includeask to include the encrypted value if secret and decrypt secret is not true (default: false)
-Optional default_Optional exclude_Optional group_Optional use_Optional company?: stringOptional name?: stringOptional username?: stringnew username
-new user info
-Optional is_Optional extra_Optional members?: string[]Optional summary?: stringOptional flow?: booleanOptional success?: booleanOptional emails?: string[]Optional summary?: stringWorkspaceInvite
-Optional azure_Optional public_Optional s3_Optional secondary_Optional azure_Optional public_Optional s3_Optional type?: "S3Storage" | "AzureBlobStorage" | "AzureWorkloadIdentity" | "S3AwsOidc"Optional type?: "S3Storage" | "AzureBlobStorage" | "AzureWorkloadIdentity" | "S3AwsOidc"Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional starred(default false) -show only the starred items
-Optional actionfilter on type of operation
-Optional after?: stringfilter on created after (exclusive) timestamp
-Optional before?: stringfilter on created before (exclusive) timestamp
-Optional operation?: stringfilter on exact or prefix name of operation
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional resource?: stringfilter on exact or prefix name of resource
-Optional username?: stringfilter on exact username of user
-Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional schedulemask to filter by schedule path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-Optional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional concurrencyOptional createdmask to filter exact matching user creator
-Optional createdfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
-Optional createdfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional rowOptional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional show(default false) -show also the archived files. -when multiple archived hash share the same path, only the ones with the latest create_at -are displayed.
-Optional starred(default false) -show only the starred items
-Optional onlyonly list the folders the user is member of (default false)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional onlyonly list the groups the user is member of (default false)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional apps?: { Optional flows?: { Optional kind?: stringquery integrations kind
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional runnableOptional runnableOptional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional createdfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
-Optional createdfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-Optional saml?: stringOptional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional isis not a scheduled job
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional suspended?: booleanfilter on suspended jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional starred(default false) -show only the starred items
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional resourceresource_types to list from, separated by ',',
-Optional resourceresource_types to not list from, separated by ',',
-Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional isOptional page?: numberwhich page to return (start at 1, default 1)
-Optional path?: stringfilter by path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional createdmask to filter exact matching user creator
-Optional firstmask to filter scripts whom first direct parent has exact hash
-Optional hide(default false) -hide the scripts without an exported main function
-Optional is(default regardless) -if true show only the templates -if false show only the non templates -if not defined, show all regardless of if the script is a template
-Optional kinds?: string(default regardless) -script kinds to filter, split by comma
-Optional lastmask to filter scripts whom last parent in the chain has exact hash. -Beware that each script stores only a limited number of parents. Hence -the last parent hash for a script is not necessarily its top-most parent. -To find the top-most parent you will have to jump from last to last hash -until finding the parent
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentis the hash present in the array of stored parent hashes for this script. -The same warning applies than for last_parent_hash. A script only store a -limited number of direct parent
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional show(default false) -show also the archived files. -when multiple archived hash share the same path, only the ones with the latest create_at -are -ed.
-Optional starred(default false) -show only the starred items
-Optional marker?: stringOptional prefix?: stringOptional storage?: stringOptional next_Optional restricted_Optional excludeOptional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional pingnumber of seconds the worker must have had a last ping more recent of (default to 300)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional starred?: booleanOptional starred?: booleanOptional account?: numberOptional description?: stringOptional extra_Optional is_Optional refresh_Optional value?: unknownOptional workspace_Optional account?: numberOptional description?: stringOptional is_Optional is_Optional is_Optional is_Optional refresh_Optional value?: stringOptional limit?: numberOptional offset?: numberOptional searchOptional searchOptional sortOptional sortOptional storage?: stringOptional storage?: stringOptional csvOptional csvOptional fileOptional fileOptional readOptional readOptional storage?: stringOptional limit?: numberOptional offset?: numberOptional searchOptional searchOptional sortOptional sortOptional storage?: stringPartially filled script
-Optional code?: stringOptional state?: stringOptional star_Optional name?: stringOptional storage?: stringOptional enabled?: booleanOptional no_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional retry?: RetryOptional summary?: stringOptional tag?: stringOptional ws_Optional cache_Optional codebase?: stringOptional concurrency_Optional concurrency_Optional concurrent_Optional dedicated_Optional delete_Optional deployment_Optional draft_Optional envs?: string[]Optional is_Optional kind?: "script" | "failure" | "trigger" | "command" | "approval"Optional lock?: stringOptional no_Optional parent_Optional priority?: numberOptional restart_Optional schema?: { Optional tag?: stringOptional timeout?: numberOptional visible_Optional ws_Optional expiration?: stringOptional label?: stringOptional scopes?: string[]Optional expiration?: stringOptional label?: stringOptional duration_Optional started_Optional typ?: stringOptional ENCODE_Optional HEADERS?: Headers | Resolver<Headers>Optional PASSWORD?: string | Resolver<string>Optional TOKEN?: string | Resolver<string>Optional USERNAME?: string | Resolver<string>Optional dedicated_Optional priority?: numberOptional tag?: stringOptional timeout?: numberOptional visible_Optional ws_Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-filter on type of operation
-filter on created after (exclusive) timestamp
-filter on jobs containing those args as a json subset (@> in postgres)
-filter on created before (exclusive) timestamp
-Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-mask to filter exact matching user creator
-filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
-filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
-List of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-filter on exact or prefix name of operation
-order by desc order (default true)
-which page to return (start at 1, default 1)
-The parent job that is at the origin and responsible for the execution of this script if any
-The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
-encodeURIComponent(btoa(JSON.stringify({a: 2})))
number of items to return for a given page (default 30, max 100)
-The maximum size of the queue for which the request would get rejected if that job would push it above that limit
-filter on exact or prefix name of resource
-filter on jobs containing those result as a json subset (@> in postgres)
-filter on running jobs
-mask to filter by schedule path
-filter on jobs scheduled_for before now (hence waitinf for a worker)
-mask to filter exact matching path
-mask to filter exact matching path
-mask to filter matching starting path
-filter on started after (exclusive) timestamp
-filter on started before (inclusive) timestamp
-filter on successful jobs
-filter on suspended jobs
-filter on jobs with a given tag/worker group
-filter on exact username of user
-Override the tag to use
-Optional hash?: stringS3 resource to connect to
-Optional s3_Optional key?: stringOptional secret?: stringS3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_Optional key?: stringOptional secret?: stringOptional aws_Optional aws_Optional execution_Optional on_Optional on_Optional triggerables?: { Optional triggerables_Optional content?: stringOptional dedicated_Optional kind?: "code" | "identity" | "http"Optional language?: "python3" | "deno" | "go" | "bash" | "powershell" | "postgresql" | "mysql" | "bigquery" | "snowflake" | "mssql" | "graphql" | "nativets" | "bun" | "php"Optional lock?: stringOptional path?: stringOptional tag?: stringschedule
-Optional app?: stringquery scripts app
-Optional kind?: stringquery scripts kind
-Optional limit?: numberquery limit
-query text
-Optional limit?: numberquery limit
-query text
-Optional schema?: unknownOptional args?: ScriptArgsOptional canceled_Optional canceled_Optional created_Optional created_Optional flow_Optional language?: "python3" | "deno" | "go" | "bash" | "powershell" | "postgresql" | "mysql" | "bigquery" | "snowflake" | "mssql" | "graphql" | "nativets" | "bun" | "php"Optional last_Optional logs?: stringOptional mem_Optional parent_The user (u/userfoo) or group (g/groupfoo) whom -the execution of this script will be permissioned_as and by extension its DT_TOKEN.
-Optional priority?: numberOptional raw_Optional raw_Optional schedule_Optional scheduled_Optional script_Optional script_Optional started_Optional workspace_Optional concurrency_Optional concurrent_Optional custom_Optional lock?: stringOptional path?: stringOptional tag?: stringvariable path
-acl to add
-added owner to folder
-Optional write?: booleanuser to remove from instance group
-added user to group
-Optional username?: stringOptional description?: stringOptional extra_Optional value?: unknownOptional workspace_Optional description?: stringOptional schema?: unknownOptional workspace_for branchall or loop, the iteration at which the flow should restart
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the flow owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-flow args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-step id to restart the flow from
-Optional tag?: stringOverride the tag to use
-Optional branch_Optional flow_Optional step_Optional approver?: stringOptional payload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
-encodeURIComponent(btoa(JSON.stringify({a: 2})))
Optional approver?: stringOptional constant?: { Optional attempts?: numberOptional seconds?: numberOptional exponential?: { Optional attempts?: numberOptional multiplier?: numberOptional random_Optional seconds?: numberpreview
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the flow owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-flow args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-preview
-raw script content
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Partially filled args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-script args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-preview
-path to hub script to run and its corresponding args
-Optional channel?: stringOptional hub_Optional test_Optional job_Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-Optional tag?: stringOverride the tag to use
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional payload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
-encodeURIComponent(btoa(JSON.stringify({a: 2})))
Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-Optional tag?: stringOverride the tag to use
-Optional storage?: stringOptional accessOptional secretS3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_Optional metric_Optional args?: ScriptArgsOptional error?: stringOptional no_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional on_Optional retry?: RetryOptional summary?: stringOptional tag?: stringOptional ws_Optional jobs?: { Optional cache_Optional codebase?: stringOptional concurrency_Optional concurrency_Optional concurrent_Optional dedicated_Optional delete_Optional draft_Optional envs?: string[]Optional has_Optional lock?: stringOptional lock_Optional parent_The first element is the direct parent of the script, the second is the parent of the first, etc
-Optional priority?: numberOptional restart_Optional schema?: { Optional tag?: stringOptional timeout?: numberOptional visible_Optional workspace_Optional ws_Optional deployment_automatic billing
-Optional seats?: numberHandler description
-Optional extra_Optional number_Optional number_Optional path?: stringOptional workspace_Workspace default app
-Optional value?: stringnew value
-value set
-Optional value?: unknownset password
-updated schedule enable
-New encryption key
-Optional bot_Optional requestOptional favorite_Optional path?: stringOptional value?: unknowntest license key
-test metadata
-test object storage config
-test smtp payload
-Optional metric_Workspace error handler enabled
-Optional muted?: booleanWorkspace error handler enabled
-Optional muted?: booleanOptional expires_Optional refresh_Optional scope?: string[]Optional expiration?: stringOptional label?: stringOptional scopes?: string[]Optional requestOptional favorite_Optional path?: stringApp deployment message
-Optional deployment_worker group
-Partially filled flow
-update folder
-Optional extra_Optional owners?: string[]updated group
-Optional summary?: stringUpdateInput
-update instance group
-updateraw app
-Optional path?: stringOptional summary?: stringOptional value?: stringupdated resource
-updated resource_type
-updated resource
-Optional value?: unknownupdated schedule
-Script deployment message
-Optional deployment_progress update
-Optional progress?: numbernew user
-Optional alreadyupdated variable
-Optional groups?: string[]Optional email?: stringOptional executions?: numberOptional parallel?: booleanOptional parallelism?: numberOptional expires?: stringOptional last_Optional mime_Optional size_Optional version_Optional content?: stringOptional msg?: stringOptional current_Optional current_Optional custom_Optional last_Optional memory?: numberOptional memory_Optional occupancy_Optional vcpus?: numberOptional wm_Optional duration_Optional name?: stringOptional scheduled_Optional started_Optional domain?: stringOptional default_Optional hidden?: string[]Optional order?: string[]Optional include_Optional include_Optional repositories?: GitRepositorySettings[]app
-hub apps list
-Optional apps?: { credentials
-Successfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
clear cookies and clear token (if applicable)
-all concurrency groups
-concurrency group removed
-concurrency key for given job
-a config
-a list of worker group configs
-Delete config
-worker group
-Update a worker group
-get license id (empty if not ee)
-Optional app?: stringquery scripts app
-Optional kind?: stringquery scripts kind
-Optional limit?: numberquery limit
-query text
-script details
-hub flows list
-Optional flows?: { user to add to instance group
-user added to instance group
-create instance group
-Optional summary?: stringinstance group created
-instance group deleted
-instance group
-instance group list
-user to remove from instance group
-user removed from instance group
-update instance group
-instance group updated
-Optional kind?: stringquery integrations kind
-integrations details
-the timestamp of the db that can be used to compute the drift
-code endpoint
-oauth token
-client name
-get
-Optional extra_Optional scopes?: string[]list of oauth connects clients
-list of oauth and saml login clients
-Optional saml?: stringPartially filled script
-Optional code?: stringOptional state?: stringSuccessfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
openapi yaml file content
-test metadata
-status
-schedule
-List of 5 estimated upcoming execution events (in UTC)
-script details
-script details
-Optional lockfile?: stringOptional schema?: unknownOptional summary?: stringOptional app?: stringquery scripts app
-Optional kind?: stringquery scripts kind
-Optional limit?: numberquery limit
-hub scripts list
-Optional asks?: { script content
-status
-value set
-Optional value?: unknownstatus
-status
-status
-status
-status
-test license key
-status
-test object storage config
-status
-test smtp payload
-status
-is backend up to date
-accept invite
-Optional username?: stringstatus
-free all runnables
-Optional description?: stringuser info
-Optional company?: stringOptional name?: stringuser created
-decline invite
-status
-user deleted
-user email
-user
-status
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-user
-list all workspace invites
-free usage
-new username
-user renamed
-set password
-password set
-delete token
-new token
-token created
-Optional excludetruncated token
-tutorial progress
-Optional progress?: numberprogress update
-Optional progress?: numbertutorial progress
-new user info
-Optional is_user updated
-free usage
-user renamed
-user email
-git version of backend
-acl to add
-Optional write?: booleangranular acl added
-acls
-acl to add
-granular acl removed
-app created
-app deleted
-app exists
-app details with draft
-app details
-app details
-app details
-app history
-App deployment message
-Optional deployment_success
-Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional starred(default false) -show only the starred items
-All apps
-app list
-app secret
-app updated
-update app
-Optional force_Optional force_Optional force_Optional path?: stringOptional raw_Optional cache_Optional lock?: stringOptional path?: stringjob uuid
-app details
-resource value
-Optional actionfilter on type of operation
-Optional after?: stringfilter on created after (exclusive) timestamp
-Optional before?: stringfilter on created before (exclusive) timestamp
-Optional operation?: stringfilter on exact or prefix name of operation
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional resource?: stringfilter on exact or prefix name of resource
-Optional username?: stringfilter on exact username of user
-a list of audit logs
-captured flow preview
-capture does not exist for this flow
-flow preview capture created
-flow preview captured
-Optional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional concurrencyOptional createdmask to filter exact matching user creator
-Optional createdfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
-Optional createdfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional rowOptional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-time
-Optional value?: unknowndraft created
-draft deleted
-Optional limit?: numberquery limit
-query text
-resource type details
-Optional requestOptional favorite_Optional path?: stringstar item
-Optional requestOptional favorite_Optional path?: stringunstar item
-archiveFlow
-Optional archived?: booleanflow archived
-Partially filled flow
-flow created
-flow delete
-flow details
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-input history for completed jobs with this flow path
-Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional show(default false) -show also the archived files. -when multiple archived hash share the same path, only the ones with the latest create_at -are displayed.
-Optional starred(default false) -show only the starred items
-All flow
-list of flow paths
-flow list
-Workspace error handler enabled
-Optional muted?: booleanerror handler toggled
-Partially filled flow
-flow updated
-owner user to folder
-owner added to folder
-create folder
-Optional extra_Optional owners?: string[]folder created
-folder deleted
-folder
-Optional onlyonly list the folders the user is member of (default false)
-folder list
-added owner to folder
-Optional write?: booleanowner removed from folder
-update folder
-Optional extra_Optional owners?: string[]folder updated
-added user to group
-Optional username?: stringuser added to group
-create group
-Optional summary?: stringgroup created
-group deleted
-Optional onlyonly list the groups the user is member of (default false)
-group list
-added user to group
-Optional username?: stringuser removed from group
-updated group
-Optional summary?: stringgroup updated
-Input
-Optional runnableOptional runnableInput created
-Input deleted
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional runnableOptional runnableInput history for completed jobs
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional runnableOptional runnableSaved Inputs for a Runnable
-UpdateInput
-Input updated
-args
-Optional storage?: stringConfirmation
-Optional resourceOptional s3Optional storage?: stringChunk of the downloaded file
-Optional resourceOptional s3The downloaded file
-S3 resource to connect to
-Optional s3_Connection settings
-Optional connection_Optional marker?: stringOptional prefix?: stringOptional storage?: stringList of file keys
-Optional next_Optional restricted_Optional limit?: numberOptional offset?: numberOptional searchOptional searchOptional sortOptional sortOptional storage?: stringCsv Preview
-Optional storage?: stringFileMetadata
-Optional csvOptional csvOptional fileOptional fileOptional readOptional readOptional storage?: stringFilePreview
-Optional limit?: numberOptional offset?: numberOptional searchOptional searchOptional sortOptional sortOptional storage?: stringParquet Preview
-Optional storage?: stringConfirmation
-S3 resource to connect to
-Optional s3_Connection settings
-Optional key?: stringOptional secret?: stringOptional storage?: stringConnection settings
-Optional fileOptional fileFile content
-Optional resourceOptional s3Optional storage?: stringFile upload status
-S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_Connection settings
-S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_Connection settings
-Optional key?: stringOptional secret?: stringOptional aws_Optional aws_S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
-Optional s3_Connection settings
-parameters for statistics retrieval
-Optional from_Optional timeseries_Optional to_job details
-Optional metrics_Optional scalar_Optional timeseries_completed count
-job details
-Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional schedulemask to filter by schedule path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-All completed jobs
-job resumed
-flow user state updated
-new value
-flow user state updated
-Optional approver?: stringjob signature
-Optional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional createdfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
-Optional createdfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
-Optional hashas null parent
-Optional isis the job a flow step
-Optional isis not a scheduled job
-Optional isis the job skipped
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional label?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-All jobs
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-job result
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-job result
-uuids of canceled jobs
-Optional allget jobs from all workspaces (only valid if request come from the admins workspace)
queue count
-Optional allget jobs from all workspaces (only valid if request come from the admins workspace)
Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional createdmask to filter exact matching user creator
-Optional isis not a scheduled job
-Optional jobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional result?: stringfilter on jobs containing those result as a json subset (@> in postgres)
-Optional running?: booleanfilter on running jobs
-Optional schedulemask to filter by schedule path
-Optional scheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter exact matching path
-Optional scriptmask to filter matching starting path
-Optional startedfilter on started after (exclusive) timestamp
-Optional startedfilter on started before (inclusive) timestamp
-Optional success?: booleanfilter on successful jobs
-Optional suspended?: booleanfilter on suspended jobs
-Optional tag?: stringfilter on jobs with a given tag/worker group
-All queued jobs
-for branchall or loop, the iteration at which the flow should restart
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the flow owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-flow args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-step id to restart the flow from
-Optional tag?: stringOverride the tag to use
-job created
-job result
-Optional approver?: stringurl endpoints
-raw script content
-dependency job result
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the flow owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-flow args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-job created
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Partially filled args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-job created
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-script args
-Optional scheduledwhen to schedule this job (leave empty for immediate run)
-Optional scheduledschedule the script to execute in the number of seconds starting now
-Optional tag?: stringOverride the tag to use
-job created
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-preview
-job created
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional invisiblemake the run invisible to the the script owner (default false)
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-preview
-job created
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-job result
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional payload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
-encodeURIComponent(btoa(JSON.stringify({a: 2})))
Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-Optional tag?: stringOverride the tag to use
-job result
-Optional cacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
-Optional includeList of headers's keys (separated with ',') whove value are added to the args -Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
-Optional jobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-Optional parentThe parent job that is at the origin and responsible for the execution of this script if any
-Optional queueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
-script args
-Optional tag?: stringOverride the tag to use
-job result
-preview
-job created
-Optional approver?: stringjob canceled
-Optional approver?: stringjob canceled
-job details
-result
-Optional getresult
-Optional started?: booleanOptional success?: booleanOptional approver?: stringflow debug info details
-job log
-job details
-get root job id
-Optional logOptional running?: booleanjob details
-Optional completed?: booleanOptional flow_Optional log_Optional mem_Optional new_Optional running?: booleanreason
-Optional reason?: stringjob canceled
-reason
-Optional reason?: stringpersistent job scaled down to zero
-reason
-Optional reason?: stringjob canceled
-Optional approver?: stringOptional payload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
-encodeURIComponent(btoa(JSON.stringify({a: 2})))
job resumed
-Optional approver?: stringjob resumed
-code endpoint
-slack token
-code endpoint
-Optional refresh_account set
-disconnected client
-disconnected slack
-variable path
-token refreshed
-new oidc token
-new raw app
-raw app created
-app deleted
-app exists
-Optional createdmask to filter exact matching user creator
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional starred(default false) -show only the starred items
-All raw apps
-updateraw app
-Optional path?: stringOptional summary?: stringOptional value?: stringapp updated
-new resource
-Optional updateresource created
-resource deleted
-does resource exists
-resource value
-Optional jobjob id
-resource value
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional resourceresource_types to list from, separated by ',',
-Optional resourceresource_types to not list from, separated by ',',
-resource list
-resource list names
-resource list
-new resource_type
-resource_type created
-resource_type deleted
-does resource_type exist
-resource_type deleted
-resource_type list
-resource_type list
-updated resource_type
-resource_type updated
-updated resource
-resource updated
-updated resource
-Optional value?: unknownresource value updated
-new schedule
-schedule created
-schedule deleted
-schedule exists
-Optional args?: stringfilter on jobs containing those args as a json subset (@> in postgres)
-Optional isOptional page?: numberwhich page to return (start at 1, default 1)
-Optional path?: stringfilter by path
-Optional pernumber of items to return for a given page (default 30, max 100)
-schedule list
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-schedule list
-Handler description
-Optional extra_Optional number_Optional number_Optional path?: stringOptional workspace_default error handler set
-updated schedule enable
-schedule enabled set
-updated schedule
-schedule updated
-script archived
-script path
-script details
-Optional lock?: stringOptional lock_does it exists
-script details
-script history
-Script deployment message
-Optional deployment_success
-Optional createdmask to filter exact matching user creator
-Optional firstmask to filter scripts whom first direct parent has exact hash
-Optional hide(default false) -hide the scripts without an exported main function
-Optional is(default regardless) -if true show only the templates -if false show only the non templates -if not defined, show all regardless of if the script is a template
-Optional kinds?: string(default regardless) -script kinds to filter, split by comma
-Optional lastmask to filter scripts whom last parent in the chain has exact hash. -Beware that each script stores only a limited number of parents. Hence -the last parent hash for a script is not necessarily its top-most parent. -To find the top-most parent you will have to jump from last to last hash -until finding the parent
-Optional orderorder by desc order (default true)
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional parentis the hash present in the array of stored parent hashes for this script. -The same warning applies than for last_parent_hash. A script only store a -limited number of direct parent
-Optional pathmask to filter exact matching path
-Optional pathmask to filter matching starting path
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional show(default false) -show also the archived files. -when multiple archived hash share the same path, only the ones with the latest create_at -are -ed.
-Optional starred(default false) -show only the starred items
-All scripts
-list of script paths
-script list
-script content
-script content
-Workspace error handler enabled
-Optional muted?: booleanerror handler toggled
-delete user
-is owner
-user
-new user
-edited user
-Optional alreadynew variable
-variable created
-variable deleted
-new variable
-encrypted value
-variable
-Optional decryptask to decrypt secret if this variable is secret -(if not secret no effect, default: true)
-Optional includeask to include the encrypted value if secret and decrypt secret is not true (default: false)
-variable
-variable
-variable list
-contextual variable list
-Optional alreadyupdated variable
-variable updated
-WorkspaceInvite
-Optional username?: stringstatus
-status
-Optional requestOptional new_Optional new_status
-Optional requestOptional new_status
-status
-Optional default_status
-Optional requestWorkspace default app
-status
-WorkspaceInvite
-status
-WorkspaceInvite
-Optional auto_Optional invite_Optional operator?: booleanstatus
-WorkspaceCopilotConfig
-Optional openai_status
-Workspace default app
-Optional default_status
-Optional deploy_status
-WorkspaceErrorHandler
-Optional error_Optional error_Optional error_status
-Workspace Git sync settings
-Optional git_status
-LargeFileStorage info
-Optional large_status
-WorkspaceInvite
-Optional slack_status
-WorkspaceWebhook
-Optional webhook?: stringstatus
-status
-New encryption key
-status
-status
-status
-Optional deploy_status
-status
-Optional auto_Optional auto_Optional auto_Optional customer_Optional default_Optional default_Optional deploy_Optional error_Optional error_Optional git_Optional large_Optional openai_Optional plan?: stringOptional slack_Optional slack_Optional slack_Optional webhook?: stringOptional workspace_status
-WorkspaceInvite
-status
-status
-status
-user
-status
-Optional seats?: numberOptional usage?: numberpath to hub script to run and its corresponding args
-Optional channel?: stringOptional hub_Optional test_status
-Optional job_automatic billing
-Optional seats?: numberstatus
-Workspace default app
-Optional value?: stringstatus
-usage
-list of custom tags
-whether a worker with the tag exists
-list of default tags
-is the default tags per workspace
-Optional page?: numberwhich page to return (start at 1, default 1)
-Optional pernumber of items to return for a given page (default 30, max 100)
-Optional pingnumber of seconds the worker must have had a last ping more recent of (default to 300)
-a list of workers
-metrics
-domain allowed or not
-new token
-token created
-status
-id of workspace
-status
-status
-status
-workspace with associated username
-Const
delete user (require admin privilege)
-