# \JobApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**batch_re_run_jobs**](JobApi.md#batch_re_run_jobs) | **POST** /w/{workspace}/jobs/run/batch_rerun_jobs | re-run multiple jobs
[**cancel_persistent_queued_jobs**](JobApi.md#cancel_persistent_queued_jobs) | **POST** /w/{workspace}/jobs_u/queue/cancel_persistent/{path} | cancel all queued jobs for persistent script
[**cancel_queued_job**](JobApi.md#cancel_queued_job) | **POST** /w/{workspace}/jobs_u/queue/cancel/{id} | cancel queued or running job
[**cancel_selection**](JobApi.md#cancel_selection) | **POST** /w/{workspace}/jobs/queue/cancel_selection | cancel jobs based on the given uuids
[**cancel_suspended_job_get**](JobApi.md#cancel_suspended_job_get) | **GET** /w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature} | cancel a job for a suspended flow
[**cancel_suspended_job_post**](JobApi.md#cancel_suspended_job_post) | **POST** /w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature} | cancel a job for a suspended flow
[**count_completed_jobs**](JobApi.md#count_completed_jobs) | **GET** /w/{workspace}/jobs/completed/count_jobs | count number of completed jobs with filter
[**count_jobs_by_tag**](JobApi.md#count_jobs_by_tag) | **GET** /jobs/completed/count_by_tag | Count jobs by tag
[**create_job_signature**](JobApi.md#create_job_signature) | **GET** /w/{workspace}/jobs/job_signature/{id}/{resume_id} | create an HMac signature given a job id and a resume id
[**delete_completed_job**](JobApi.md#delete_completed_job) | **POST** /w/{workspace}/jobs/completed/delete/{id} | delete completed job (erase content but keep run id)
[**delete_jobs**](JobApi.md#delete_jobs) | **POST** /w/{workspace}/jobs/delete | delete jobs by IDs from all related tables
[**export_completed_jobs**](JobApi.md#export_completed_jobs) | **GET** /w/{workspace}/jobs/completed/export | export all completed jobs for backup/migration
[**export_queued_jobs**](JobApi.md#export_queued_jobs) | **GET** /w/{workspace}/jobs/queue/export | export all queued jobs for backup/migration
[**force_cancel_queued_job**](JobApi.md#force_cancel_queued_job) | **POST** /w/{workspace}/jobs_u/queue/force_cancel/{id} | force cancel queued job
[**get_approval_info**](JobApi.md#get_approval_info) | **GET** /w/{workspace}/jobs_u/flow/approval_info/{job_id} | get approval info for a suspended flow/WAC job
[**get_completed_count**](JobApi.md#get_completed_count) | **GET** /w/{workspace}/jobs/completed/count | get completed count
[**get_completed_job**](JobApi.md#get_completed_job) | **GET** /w/{workspace}/jobs_u/completed/get/{id} | get completed job
[**get_completed_job_logs_tail**](JobApi.md#get_completed_job_logs_tail) | **GET** /w/{workspace}/jobs_u/get_completed_logs_tail/{id} | get completed job logs tail
[**get_completed_job_result**](JobApi.md#get_completed_job_result) | **GET** /w/{workspace}/jobs_u/completed/get_result/{id} | get completed job result
[**get_completed_job_result_maybe**](JobApi.md#get_completed_job_result_maybe) | **GET** /w/{workspace}/jobs_u/completed/get_result_maybe/{id} | get completed job result if job is completed
[**get_completed_job_timing**](JobApi.md#get_completed_job_timing) | **GET** /w/{workspace}/jobs_u/completed/get_timing/{id} | get completed job timing
[**get_db_clock**](JobApi.md#get_db_clock) | **GET** /jobs/db_clock | get db clock
[**get_flow_all_logs**](JobApi.md#get_flow_all_logs) | **GET** /w/{workspace}/jobs_u/get_flow_all_logs/{id} | get all logs for a flow job
[**get_flow_debug_info**](JobApi.md#get_flow_debug_info) | **GET** /w/{workspace}/jobs_u/get_flow_debug_info/{id} | get flow debug info
[**get_flow_user_state**](JobApi.md#get_flow_user_state) | **GET** /w/{workspace}/jobs/flow/user_states/{id}/{key} | get flow user state at a given key
[**get_job**](JobApi.md#get_job) | **GET** /w/{workspace}/jobs_u/get/{id} | get job
[**get_job_args**](JobApi.md#get_job_args) | **GET** /w/{workspace}/jobs_u/get_args/{id} | get job args
[**get_job_logs**](JobApi.md#get_job_logs) | **GET** /w/{workspace}/jobs_u/get_logs/{id} | get job logs
[**get_job_otel_traces**](JobApi.md#get_job_otel_traces) | **GET** /w/{workspace}/jobs/get_otel_traces/{id} | get OpenTelemetry traces for a job
[**get_job_updates**](JobApi.md#get_job_updates) | **GET** /w/{workspace}/jobs_u/getupdate/{id} | get job updates
[**get_job_updates_sse**](JobApi.md#get_job_updates_sse) | **GET** /w/{workspace}/jobs_u/getupdate_sse/{id} | get job updates via server-sent events
[**get_log_file_from_store**](JobApi.md#get_log_file_from_store) | **GET** /w/{workspace}/jobs_u/get_log_file/{path} | get log file from object store
[**get_queue_count**](JobApi.md#get_queue_count) | **GET** /w/{workspace}/jobs/queue/count | get queue count
[**get_queue_position**](JobApi.md#get_queue_position) | **GET** /w/{workspace}/jobs/queue/position/{scheduled_for} | get queue position for a job
[**get_resume_urls**](JobApi.md#get_resume_urls) | **GET** /w/{workspace}/jobs/resume_urls/{id}/{resume_id} | get resume urls given a job_id, resume_id and a nonce to resume a flow
[**get_root_job_id**](JobApi.md#get_root_job_id) | **GET** /w/{workspace}/jobs_u/get_root_job_id/{id} | get root job id
[**get_scheduled_for**](JobApi.md#get_scheduled_for) | **GET** /w/{workspace}/jobs/queue/scheduled_for/{id} | get scheduled for timestamp for a job
[**get_slack_approval_payload**](JobApi.md#get_slack_approval_payload) | **GET** /w/{workspace}/jobs/slack_approval/{id} | generate interactive slack approval for suspended job
[**get_started_at_by_ids**](JobApi.md#get_started_at_by_ids) | **POST** /w/{workspace}/jobs_u/queue/get_started_at_by_ids | get started at by ids
[**get_suspended_job_flow**](JobApi.md#get_suspended_job_flow) | **GET** /w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature} | get parent flow job of suspended job
[**get_teams_approval_payload**](JobApi.md#get_teams_approval_payload) | **GET** /w/{workspace}/jobs/teams_approval/{id} | generate interactive teams approval for suspended job
[**import_completed_jobs**](JobApi.md#import_completed_jobs) | **POST** /w/{workspace}/jobs/completed/import | import completed jobs from backup/migration
[**import_queued_jobs**](JobApi.md#import_queued_jobs) | **POST** /w/{workspace}/jobs/queue/import | import queued jobs from backup/migration
[**list_completed_jobs**](JobApi.md#list_completed_jobs) | **GET** /w/{workspace}/jobs/completed/list | list all completed jobs
[**list_extended_jobs**](JobApi.md#list_extended_jobs) | **GET** /w/{workspace}/concurrency_groups/list_jobs | Get intervals of job runtime concurrency
[**list_filtered_jobs_uuids**](JobApi.md#list_filtered_jobs_uuids) | **GET** /w/{workspace}/jobs/list_filtered_uuids | get the ids of all jobs matching the given filters
[**list_filtered_queue_uuids**](JobApi.md#list_filtered_queue_uuids) | **GET** /w/{workspace}/jobs/queue/list_filtered_uuids | get the ids of all queued jobs matching the given filters
[**list_jobs**](JobApi.md#list_jobs) | **GET** /w/{workspace}/jobs/list | list all jobs
[**list_queue**](JobApi.md#list_queue) | **GET** /w/{workspace}/jobs/queue/list | list all queued jobs
[**list_selected_job_groups**](JobApi.md#list_selected_job_groups) | **POST** /w/{workspace}/jobs/list_selected_job_groups | list selected jobs script/flow schemas grouped by (kind, path)
[**restart_flow_at_step**](JobApi.md#restart_flow_at_step) | **POST** /w/{workspace}/jobs/restart/f/{id} | restart a completed flow at a given step
[**result_by_id**](JobApi.md#result_by_id) | **GET** /w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id} | get job result by id
[**resume_suspended**](JobApi.md#resume_suspended) | **POST** /w/{workspace}/jobs_u/flow/resume_suspended/{job_id} | resume or cancel a suspended flow/WAC job
[**resume_suspended_flow_as_owner**](JobApi.md#resume_suspended_flow_as_owner) | **POST** /w/{workspace}/jobs/flow/resume/{id} | resume a job for a suspended flow as an owner
[**resume_suspended_job_get**](JobApi.md#resume_suspended_job_get) | **GET** /w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature} | resume a job for a suspended flow
[**resume_suspended_job_post**](JobApi.md#resume_suspended_job_post) | **POST** /w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature} | resume a job for a suspended flow
[**run_and_stream_flow_by_path**](JobApi.md#run_and_stream_flow_by_path) | **POST** /w/{workspace}/jobs/run_and_stream/f/{path} | run flow by path and stream updates via SSE
[**run_and_stream_flow_by_path_get**](JobApi.md#run_and_stream_flow_by_path_get) | **GET** /w/{workspace}/jobs/run_and_stream/f/{path} | run flow by path with GET and stream updates via SSE
[**run_and_stream_flow_by_version**](JobApi.md#run_and_stream_flow_by_version) | **POST** /w/{workspace}/jobs/run_and_stream/fv/{version} | run flow by version and stream updates via SSE
[**run_and_stream_flow_by_version_get**](JobApi.md#run_and_stream_flow_by_version_get) | **GET** /w/{workspace}/jobs/run_and_stream/fv/{version} | run flow by version with GET and stream updates via SSE
[**run_and_stream_script_by_hash**](JobApi.md#run_and_stream_script_by_hash) | **POST** /w/{workspace}/jobs/run_and_stream/h/{hash} | run script by hash and stream updates via SSE
[**run_and_stream_script_by_hash_get**](JobApi.md#run_and_stream_script_by_hash_get) | **GET** /w/{workspace}/jobs/run_and_stream/h/{hash} | run script by hash with GET and stream updates via SSE
[**run_and_stream_script_by_path**](JobApi.md#run_and_stream_script_by_path) | **POST** /w/{workspace}/jobs/run_and_stream/p/{path} | run script by path and stream updates via SSE
[**run_and_stream_script_by_path_get**](JobApi.md#run_and_stream_script_by_path_get) | **GET** /w/{workspace}/jobs/run_and_stream/p/{path} | run script by path with GET and stream updates via SSE
[**run_code_workflow_task**](JobApi.md#run_code_workflow_task) | **POST** /w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint} | run code-workflow task
[**run_dynamic_select**](JobApi.md#run_dynamic_select) | **POST** /w/{workspace}/jobs/run/dynamic_select | run dynamic select helper function
[**run_flow_by_path**](JobApi.md#run_flow_by_path) | **POST** /w/{workspace}/jobs/run/f/{path} | run flow by path
[**run_flow_by_version**](JobApi.md#run_flow_by_version) | **POST** /w/{workspace}/jobs/run/fv/{version} | run flow by version
[**run_flow_dependencies_async**](JobApi.md#run_flow_dependencies_async) | **POST** /w/{workspace}/jobs/run/flow_dependencies_async | queue a one-off flow dependencies job and return the job uuid
[**run_flow_preview**](JobApi.md#run_flow_preview) | **POST** /w/{workspace}/jobs/run/preview_flow | run flow preview
[**run_flow_preview_and_wait_result**](JobApi.md#run_flow_preview_and_wait_result) | **POST** /w/{workspace}/jobs/run_wait_result/preview_flow | run flow preview and wait for result
[**run_raw_script_dependencies**](JobApi.md#run_raw_script_dependencies) | **POST** /w/{workspace}/jobs/run/dependencies | run a one-off dependencies job
[**run_raw_script_dependencies_async**](JobApi.md#run_raw_script_dependencies_async) | **POST** /w/{workspace}/jobs/run/dependencies_async | queue a one-off dependencies job and return the job uuid
[**run_script_by_hash**](JobApi.md#run_script_by_hash) | **POST** /w/{workspace}/jobs/run/h/{hash} | run script by hash
[**run_script_by_hash_inline**](JobApi.md#run_script_by_hash_inline) | **POST** /w/{workspace}/jobs/run_inline/h/{hash} | run script by hash without starting a new job
[**run_script_by_path**](JobApi.md#run_script_by_path) | **POST** /w/{workspace}/jobs/run/p/{path} | run script by path
[**run_script_by_path_inline**](JobApi.md#run_script_by_path_inline) | **POST** /w/{workspace}/jobs/run_inline/p/{path} | run script by path without starting a new job
[**run_script_preview**](JobApi.md#run_script_preview) | **POST** /w/{workspace}/jobs/run/preview | run script preview
[**run_script_preview_and_wait_result**](JobApi.md#run_script_preview_and_wait_result) | **POST** /w/{workspace}/jobs/run_wait_result/preview | run script preview and wait for result
[**run_script_preview_inline**](JobApi.md#run_script_preview_inline) | **POST** /w/{workspace}/jobs/run_inline/preview | run script preview without starting a new job
[**run_wait_result_flow_by_path**](JobApi.md#run_wait_result_flow_by_path) | **POST** /w/{workspace}/jobs/run_wait_result/f/{path} | run flow by path and wait until completion
[**run_wait_result_flow_by_version**](JobApi.md#run_wait_result_flow_by_version) | **POST** /w/{workspace}/jobs/run_wait_result/fv/{version} | run flow by version and wait until completion
[**run_wait_result_flow_by_version_get**](JobApi.md#run_wait_result_flow_by_version_get) | **GET** /w/{workspace}/jobs/run_wait_result/fv/{version} | run flow by version with GET and wait until completion
[**run_wait_result_script_by_path**](JobApi.md#run_wait_result_script_by_path) | **POST** /w/{workspace}/jobs/run_wait_result/p/{path} | run script by path
[**run_wait_result_script_by_path_get**](JobApi.md#run_wait_result_script_by_path_get) | **GET** /w/{workspace}/jobs/run_wait_result/p/{path} | run script by path with get
[**set_flow_user_state**](JobApi.md#set_flow_user_state) | **POST** /w/{workspace}/jobs/flow/user_states/{id}/{key} | set flow user state at a given key



## batch_re_run_jobs

> String batch_re_run_jobs(workspace, batch_re_run_jobs_request)
re-run multiple jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**batch_re_run_jobs_request** | [**BatchReRunJobsRequest**](BatchReRunJobsRequest.md) | list of job ids to re run and arg tranforms | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_persistent_queued_jobs

> String cancel_persistent_queued_jobs(workspace, path, cancel_queued_job_request)
cancel all queued jobs for persistent script

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**cancel_queued_job_request** | [**CancelQueuedJobRequest**](CancelQueuedJobRequest.md) | reason | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_queued_job

> String cancel_queued_job(workspace, id, cancel_queued_job_request)
cancel queued or running job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**cancel_queued_job_request** | [**CancelQueuedJobRequest**](CancelQueuedJobRequest.md) | reason | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_selection

> Vec<String> cancel_selection(workspace, request_body, force_cancel, all_workspaces)
cancel jobs based on the given uuids

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**request_body** | [**Vec<String>**](String.md) | uuids of the jobs to cancel | [required] |
**force_cancel** | Option<**bool**> |  |  |
**all_workspaces** | Option<**bool**> |  |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_suspended_job_get

> String cancel_suspended_job_get(workspace, id, resume_id, signature, approver)
cancel a job for a suspended flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**signature** | **String** |  | [required] |
**approver** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_suspended_job_post

> String cancel_suspended_job_post(workspace, id, resume_id, signature, body, approver)
cancel a job for a suspended flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**signature** | **String** |  | [required] |
**body** | **serde_json::Value** |  | [required] |
**approver** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## count_completed_jobs

> i32 count_completed_jobs(workspace, completed_after_s_ago, success, tags, all_workspaces)
count number of completed jobs with filter

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**completed_after_s_ago** | Option<**i32**> |  |  |
**success** | Option<**bool**> |  |  |
**tags** | Option<**String**> |  |  |
**all_workspaces** | Option<**bool**> |  |  |

### Return type

**i32**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## count_jobs_by_tag

> Vec<models::CountJobsByTag200ResponseInner> count_jobs_by_tag(horizon_secs, workspace_id)
Count jobs by tag

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**horizon_secs** | Option<**i32**> | Past Time horizon in seconds (when to start the count = now - horizon) (default is 3600) |  |
**workspace_id** | Option<**String**> | Specific workspace ID to filter results (optional) |  |

### Return type

[**Vec<models::CountJobsByTag200ResponseInner>**](countJobsByTag_200_response_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_job_signature

> String create_job_signature(workspace, id, resume_id, approver)
create an HMac signature given a job id and a resume id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**approver** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_completed_job

> models::CompletedJob delete_completed_job(workspace, id)
delete completed job (erase content but keep run id)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::CompletedJob**](CompletedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_jobs

> String delete_jobs(workspace, uuid_colon_colon_uuid)
delete jobs by IDs from all related tables

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**uuid_colon_colon_uuid** | [**Vec<uuid::Uuid>**](uuid::Uuid.md) |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_completed_jobs

> Vec<models::ExportableCompletedJob> export_completed_jobs(workspace, page, per_page)
export all completed jobs for backup/migration

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::ExportableCompletedJob>**](ExportableCompletedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_queued_jobs

> Vec<models::ExportableQueuedJob> export_queued_jobs(workspace, page, per_page)
export all queued jobs for backup/migration

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::ExportableQueuedJob>**](ExportableQueuedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## force_cancel_queued_job

> String force_cancel_queued_job(workspace, id, cancel_queued_job_request)
force cancel queued job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**cancel_queued_job_request** | [**CancelQueuedJobRequest**](CancelQueuedJobRequest.md) | reason | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_approval_info

> models::GetApprovalInfo200Response get_approval_info(workspace, job_id, token)
get approval info for a suspended flow/WAC job

Get approval info for a suspended flow/WAC job. Returns form schema, approval rules, and whether the current user can approve. Either a valid token query parameter or an authenticated session is required. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**job_id** | **uuid::Uuid** |  | [required] |
**token** | Option<**String**> | approval token for unauthenticated access |  |

### Return type

[**models::GetApprovalInfo200Response**](getApprovalInfo_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_count

> models::GetCompletedCount200Response get_completed_count(workspace)
get completed count

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**models::GetCompletedCount200Response**](getCompletedCount_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_job

> models::CompletedJob get_completed_job(workspace, id)
get completed job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::CompletedJob**](CompletedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_job_logs_tail

> String get_completed_job_logs_tail(workspace, id)
get completed job logs tail

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_job_result

> serde_json::Value get_completed_job_result(workspace, id, suspended_job, resume_id, secret, approver)
get completed job result

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**suspended_job** | Option<**String**> |  |  |
**resume_id** | Option<**i32**> |  |  |
**secret** | Option<**String**> |  |  |
**approver** | Option<**String**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_job_result_maybe

> models::GetCompletedJobResultMaybe200Response get_completed_job_result_maybe(workspace, id, get_started)
get completed job result if job is completed

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**get_started** | Option<**bool**> |  |  |

### Return type

[**models::GetCompletedJobResultMaybe200Response**](getCompletedJobResultMaybe_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_completed_job_timing

> models::GetCompletedJobTiming200Response get_completed_job_timing(workspace, id)
get completed job timing

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::GetCompletedJobTiming200Response**](getCompletedJobTiming_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_db_clock

> i32 get_db_clock()
get db clock

### Parameters

This endpoint does not need any parameter.

### Return type

**i32**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_flow_all_logs

> String get_flow_all_logs(workspace, id)
get all logs for a flow job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_flow_debug_info

> serde_json::Value get_flow_debug_info(workspace, id)
get flow debug info

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_flow_user_state

> serde_json::Value get_flow_user_state(workspace, id, key)
get flow user state at a given key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**key** | **String** |  | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job

> models::Job get_job(workspace, id, no_logs, no_code, approval_token)
get job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**no_logs** | Option<**bool**> |  |  |
**no_code** | Option<**bool**> |  |  |
**approval_token** | Option<**String**> | Approval token granting read access to the job when not logged in. The token must be the one issued for this job's flow (i.e. the flow id used when generating the approval URL). |  |

### Return type

[**models::Job**](Job.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job_args

> serde_json::Value get_job_args(workspace, id)
get job args

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job_logs

> String get_job_logs(workspace, id, remove_ansi_warnings)
get job logs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**remove_ansi_warnings** | Option<**bool**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job_otel_traces

> Vec<serde_json::Value> get_job_otel_traces(workspace, id)
get OpenTelemetry traces for a job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**Vec<serde_json::Value>**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job_updates

> models::GetJobUpdates200Response get_job_updates(workspace, id, running, log_offset, stream_offset, get_progress, no_logs)
get job updates

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**running** | Option<**bool**> |  |  |
**log_offset** | Option<**i32**> |  |  |
**stream_offset** | Option<**i32**> |  |  |
**get_progress** | Option<**bool**> |  |  |
**no_logs** | Option<**bool**> |  |  |

### Return type

[**models::GetJobUpdates200Response**](getJobUpdates_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_job_updates_sse

> String get_job_updates_sse(workspace, id, running, log_offset, stream_offset, get_progress, only_result, no_logs, fast)
get job updates via server-sent events

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**running** | Option<**bool**> |  |  |
**log_offset** | Option<**i32**> |  |  |
**stream_offset** | Option<**i32**> |  |  |
**get_progress** | Option<**bool**> |  |  |
**only_result** | Option<**bool**> |  |  |
**no_logs** | Option<**bool**> |  |  |
**fast** | Option<**bool**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_log_file_from_store

> String get_log_file_from_store(workspace, path)
get log file from object store

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_queue_count

> models::GetQueueCount200Response get_queue_count(workspace, all_workspaces)
get queue count

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |

### Return type

[**models::GetQueueCount200Response**](getQueueCount_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_queue_position

> models::GetQueuePosition200Response get_queue_position(workspace, scheduled_for)
get queue position for a job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**scheduled_for** | **i32** |  | [required] |

### Return type

[**models::GetQueuePosition200Response**](getQueuePosition_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_resume_urls

> models::GetResumeUrls200Response get_resume_urls(workspace, id, resume_id, approver, flow_level)
get resume urls given a job_id, resume_id and a nonce to resume a flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**approver** | Option<**String**> |  |  |
**flow_level** | Option<**bool**> | If true, generate resume URLs for the parent flow instead of the specific step. This allows pre-approvals that can be consumed by any later suspend step in the same flow. |  |

### Return type

[**models::GetResumeUrls200Response**](getResumeUrls_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_root_job_id

> String get_root_job_id(workspace, id)
get root job id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_scheduled_for

> i32 get_scheduled_for(workspace, id)
get scheduled for timestamp for a job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**i32**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_slack_approval_payload

> get_slack_approval_payload(workspace, id, slack_resource_path, channel_id, flow_step_id, approver, message, default_args_json, dynamic_enums_json, resume_button_text, cancel_button_text)
generate interactive slack approval for suspended job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**slack_resource_path** | **String** |  | [required] |
**channel_id** | **String** |  | [required] |
**flow_step_id** | **String** |  | [required] |
**approver** | Option<**String**> |  |  |
**message** | Option<**String**> |  |  |
**default_args_json** | Option<**String**> |  |  |
**dynamic_enums_json** | Option<**String**> |  |  |
**resume_button_text** | Option<**String**> |  |  |
**cancel_button_text** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_started_at_by_ids

> Vec<String> get_started_at_by_ids(workspace, request_body)
get started at by ids

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**request_body** | [**Vec<String>**](String.md) | ids | [required] |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_suspended_job_flow

> models::GetSuspendedJobFlow200Response get_suspended_job_flow(workspace, id, resume_id, signature, approver)
get parent flow job of suspended job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**signature** | **String** |  | [required] |
**approver** | Option<**String**> |  |  |

### Return type

[**models::GetSuspendedJobFlow200Response**](getSuspendedJobFlow_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_teams_approval_payload

> get_teams_approval_payload(workspace, id, team_name, channel_name, flow_step_id, approver, message, default_args_json, dynamic_enums_json, resume_button_text, cancel_button_text)
generate interactive teams approval for suspended job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**team_name** | **String** |  | [required] |
**channel_name** | **String** |  | [required] |
**flow_step_id** | **String** |  | [required] |
**approver** | Option<**String**> |  |  |
**message** | Option<**String**> |  |  |
**default_args_json** | Option<**String**> |  |  |
**dynamic_enums_json** | Option<**String**> |  |  |
**resume_button_text** | Option<**String**> |  |  |
**cancel_button_text** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## import_completed_jobs

> String import_completed_jobs(workspace, exportable_completed_job)
import completed jobs from backup/migration

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**exportable_completed_job** | [**Vec<models::ExportableCompletedJob>**](ExportableCompletedJob.md) |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## import_queued_jobs

> String import_queued_jobs(workspace, exportable_queued_job)
import queued jobs from backup/migration

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**exportable_queued_job** | [**Vec<models::ExportableQueuedJob>**](ExportableQueuedJob.md) |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_completed_jobs

> Vec<models::CompletedJob> list_completed_jobs(workspace, order_desc, created_by, label, worker, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, success, job_kinds, args, result, allow_wildcards, tag, page, per_page, is_skipped, is_flow_step, has_null_parent, is_not_schedule)
list all completed jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**order_desc** | Option<**bool**> | order by desc order (default true) |  |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**label** | Option<**String**> | filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release') |  |
**worker** | Option<**String**> | filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**is_skipped** | Option<**bool**> | is the job skipped |  |
**is_flow_step** | Option<**bool**> | is the job a flow step |  |
**has_null_parent** | Option<**bool**> | has null parent |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

[**Vec<models::CompletedJob>**](CompletedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_extended_jobs

> models::ExtendedJobs list_extended_jobs(workspace, concurrency_key, row_limit, created_by, label, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, running, scheduled_for_before_now, completed_before, completed_after, created_before_queue, created_after_queue, job_kinds, args, tag, result, allow_wildcards, page, per_page, trigger_kind, is_skipped, is_flow_step, has_null_parent, success, all_workspaces, is_not_schedule)
Get intervals of job runtime concurrency

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**concurrency_key** | Option<**String**> |  |  |
**row_limit** | Option<**f64**> |  |  |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**label** | Option<**String**> | filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**running** | Option<**bool**> | filter on running jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**completed_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**completed_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_before_queue** | Option<**String**> | filter on jobs created before X for jobs in the queue only |  |
**created_after_queue** | Option<**String**> | filter on jobs created after X for jobs in the queue only |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**trigger_kind** | Option<**String**> | filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook') |  |
**is_skipped** | Option<**bool**> | is the job skipped |  |
**is_flow_step** | Option<**bool**> | is the job a flow step |  |
**has_null_parent** | Option<**bool**> | has null parent |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

[**models::ExtendedJobs**](ExtendedJobs.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_filtered_jobs_uuids

> Vec<String> list_filtered_jobs_uuids(workspace, created_by, label, worker, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, created_before, created_after, completed_before, completed_after, created_before_queue, created_after_queue, running, scheduled_for_before_now, job_kinds, suspended, args, tag, result, page, per_page, is_skipped, is_flow_step, has_null_parent, success, all_workspaces, is_not_schedule)
get the ids of all jobs matching the given filters

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**label** | Option<**String**> | filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release') |  |
**worker** | Option<**String**> | filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_before** | Option<**String**> | filter on created before (inclusive) timestamp |  |
**created_after** | Option<**String**> | filter on created after (exclusive) timestamp |  |
**completed_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**completed_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_before_queue** | Option<**String**> | filter on jobs created before X for jobs in the queue only |  |
**created_after_queue** | Option<**String**> | filter on jobs created after X for jobs in the queue only |  |
**running** | Option<**bool**> | filter on running jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**suspended** | Option<**bool**> | filter on suspended jobs |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**is_skipped** | Option<**bool**> | is the job skipped |  |
**is_flow_step** | Option<**bool**> | is the job a flow step |  |
**has_null_parent** | Option<**bool**> | has null parent |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_filtered_queue_uuids

> Vec<String> list_filtered_queue_uuids(workspace, order_desc, created_by, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, success, scheduled_for_before_now, job_kinds, suspended, running, args, result, allow_wildcards, tag, page, per_page, concurrency_key, all_workspaces, is_not_schedule)
get the ids of all queued jobs matching the given filters

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**order_desc** | Option<**bool**> | order by desc order (default true) |  |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**suspended** | Option<**bool**> | filter on suspended jobs |  |
**running** | Option<**bool**> | filter on running jobs |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**concurrency_key** | Option<**String**> |  |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_jobs

> Vec<models::Job> list_jobs(workspace, created_by, label, worker, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, created_before, created_after, completed_before, completed_after, created_before_queue, created_after_queue, running, scheduled_for_before_now, job_kinds, suspended, args, tag, result, allow_wildcards, per_page, trigger_kind, is_skipped, is_flow_step, has_null_parent, success, all_workspaces, is_not_schedule, broad_filter)
list all jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**label** | Option<**String**> | filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release') |  |
**worker** | Option<**String**> | filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_before** | Option<**String**> | filter on created before (inclusive) timestamp |  |
**created_after** | Option<**String**> | filter on created after (exclusive) timestamp |  |
**completed_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**completed_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_before_queue** | Option<**String**> | filter on jobs created before X for jobs in the queue only |  |
**created_after_queue** | Option<**String**> | filter on jobs created after X for jobs in the queue only |  |
**running** | Option<**bool**> | filter on running jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**suspended** | Option<**bool**> | filter on suspended jobs |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**trigger_kind** | Option<**String**> | filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook') |  |
**is_skipped** | Option<**bool**> | is the job skipped |  |
**is_flow_step** | Option<**bool**> | is the job a flow step |  |
**has_null_parent** | Option<**bool**> | has null parent |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |
**broad_filter** | Option<**String**> | broad search across multiple fields (case-insensitive substring match on path, tag, schedule path, trigger kind, label) |  |

### Return type

[**Vec<models::Job>**](Job.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_queue

> Vec<models::QueuedJob> list_queue(workspace, order_desc, created_by, parent_job, worker, script_path_exact, script_path_start, schedule_path, trigger_path, trigger_kind, script_hash, started_before, started_after, success, scheduled_for_before_now, job_kinds, suspended, running, args, result, allow_wildcards, tag, page, per_page, all_workspaces, is_not_schedule)
list all queued jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**order_desc** | Option<**bool**> | order by desc order (default true) |  |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**worker** | Option<**String**> | filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2') |  |
**script_path_exact** | Option<**String**> | filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2') |  |
**script_path_start** | Option<**String**> | filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2') |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**trigger_path** | Option<**String**> | filter by trigger path. Supports comma-separated list (e.g. 'f/trigger1,f/trigger2') and negation by prefixing all values with '!' (e.g. '!f/trigger1,!f/trigger2') |  |
**trigger_kind** | Option<**String**> | filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook') |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**job_kinds** | Option<**String**> | filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies') |  |
**suspended** | Option<**bool**> | filter on suspended jobs |  |
**running** | Option<**bool**> | filter on running jobs |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**tag** | Option<**String**> | filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem') |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

[**Vec<models::QueuedJob>**](QueuedJob.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_selected_job_groups

> Vec<models::ListSelectedJobGroups200ResponseInner> list_selected_job_groups(workspace, uuid_colon_colon_uuid)
list selected jobs script/flow schemas grouped by (kind, path)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**uuid_colon_colon_uuid** | [**Vec<uuid::Uuid>**](uuid::Uuid.md) | script args | [required] |

### Return type

[**Vec<models::ListSelectedJobGroups200ResponseInner>**](listSelectedJobGroups_200_response_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## restart_flow_at_step

> uuid::Uuid restart_flow_at_step(workspace, id, restart_flow_at_step_request, scheduled_for, scheduled_in_secs, parent_job, tag, job_id, include_header, invisible_to_owner)
restart a completed flow at a given step

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**restart_flow_at_step_request** | [**RestartFlowAtStepRequest**](RestartFlowAtStepRequest.md) | restart flow parameters | [required] |
**scheduled_for** | Option<**String**> | when to schedule this job (leave empty for immediate run) |  |
**scheduled_in_secs** | Option<**i32**> | schedule the script to execute in the number of seconds starting now |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the flow owner (default false) |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## result_by_id

> serde_json::Value result_by_id(workspace, flow_job_id, node_id)
get job result by id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**flow_job_id** | **String** |  | [required] |
**node_id** | **String** |  | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## resume_suspended

> String resume_suspended(workspace, job_id, resume_suspended_request)
resume or cancel a suspended flow/WAC job

Resume or cancel a suspended flow/WAC job. Uses approval rules to determine authorization. Either a valid approval_token or an authenticated session is required. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**job_id** | **uuid::Uuid** |  | [required] |
**resume_suspended_request** | [**ResumeSuspendedRequest**](ResumeSuspendedRequest.md) |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## resume_suspended_flow_as_owner

> String resume_suspended_flow_as_owner(workspace, id, body)
resume a job for a suspended flow as an owner

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**body** | **serde_json::Value** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## resume_suspended_job_get

> String resume_suspended_job_get(workspace, id, resume_id, signature, payload, approver)
resume a job for a suspended flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**signature** | **String** |  | [required] |
**payload** | Option<**String**> | 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})))`  |  |
**approver** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## resume_suspended_job_post

> String resume_suspended_job_post(workspace, id, resume_id, signature, body, approver)
resume a job for a suspended flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**resume_id** | **i32** |  | [required] |
**signature** | **String** |  | [required] |
**body** | **serde_json::Value** |  | [required] |
**approver** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_flow_by_path

> String run_and_stream_flow_by_path(workspace, path, request_body, include_header, queue_limit, job_id, skip_preprocessor, memory_id, poll_delay_ms)
run flow by path and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | flow args | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_flow_by_path_get

> String run_and_stream_flow_by_path_get(workspace, path, include_header, queue_limit, payload, job_id, skip_preprocessor, memory_id, poll_delay_ms)
run flow by path with GET and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_flow_by_version

> String run_and_stream_flow_by_version(workspace, version, request_body, include_header, queue_limit, job_id, skip_preprocessor, memory_id, poll_delay_ms)
run flow by version and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **i64** | flow version ID | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | flow args | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_flow_by_version_get

> String run_and_stream_flow_by_version_get(workspace, version, include_header, queue_limit, payload, job_id, skip_preprocessor, memory_id, poll_delay_ms)
run flow by version with GET and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **i64** | flow version ID | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_script_by_hash

> String run_and_stream_script_by_hash(workspace, hash, request_body, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, skip_preprocessor, poll_delay_ms)
run script by hash and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**hash** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_script_by_hash_get

> String run_and_stream_script_by_hash_get(workspace, hash, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, payload, skip_preprocessor, poll_delay_ms)
run script by hash with GET and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**hash** | **String** |  | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_script_by_path

> String run_and_stream_script_by_path(workspace, path, request_body, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, skip_preprocessor, poll_delay_ms)
run script by path and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_and_stream_script_by_path_get

> String run_and_stream_script_by_path_get(workspace, path, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, payload, skip_preprocessor, poll_delay_ms)
run script by path with GET and stream updates via SSE

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**poll_delay_ms** | Option<**i64**> | delay between polling for job updates in milliseconds |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_code_workflow_task

> uuid::Uuid run_code_workflow_task(workspace, job_id, entrypoint, workflow_task)
run code-workflow task

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**job_id** | **String** |  | [required] |
**entrypoint** | **String** |  | [required] |
**workflow_task** | [**WorkflowTask**](WorkflowTask.md) | preview | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_dynamic_select

> uuid::Uuid run_dynamic_select(workspace, dynamic_input_data)
run dynamic select helper function

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**dynamic_input_data** | [**DynamicInputData**](DynamicInputData.md) | dynamic select request | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_flow_by_path

> uuid::Uuid run_flow_by_path(workspace, path, request_body, scheduled_for, scheduled_in_secs, skip_preprocessor, parent_job, tag, job_id, include_header, invisible_to_owner, memory_id)
run flow by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | flow args | [required] |
**scheduled_for** | Option<**String**> | when to schedule this job (leave empty for immediate run) |  |
**scheduled_in_secs** | Option<**i32**> | schedule the script to execute in the number of seconds starting now |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the flow owner (default false) |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_flow_by_version

> uuid::Uuid run_flow_by_version(workspace, version, request_body, scheduled_for, scheduled_in_secs, skip_preprocessor, parent_job, tag, job_id, include_header, invisible_to_owner, memory_id)
run flow by version

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **i64** | flow version ID | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | flow args | [required] |
**scheduled_for** | Option<**String**> | when to schedule this job (leave empty for immediate run) |  |
**scheduled_in_secs** | Option<**i32**> | schedule the script to execute in the number of seconds starting now |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the flow owner (default false) |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_flow_dependencies_async

> uuid::Uuid run_flow_dependencies_async(workspace, run_flow_dependencies_async_request)
queue a one-off flow dependencies job and return the job uuid

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**run_flow_dependencies_async_request** | [**RunFlowDependenciesAsyncRequest**](RunFlowDependenciesAsyncRequest.md) | flow value and path | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_flow_preview

> uuid::Uuid run_flow_preview(workspace, flow_preview, include_header, invisible_to_owner, job_id, memory_id)
run flow preview

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**flow_preview** | [**FlowPreview**](FlowPreview.md) | preview | [required] |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the script owner (default false) |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_flow_preview_and_wait_result

> serde_json::Value run_flow_preview_and_wait_result(workspace, flow_preview, memory_id)
run flow preview and wait for result

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**flow_preview** | [**FlowPreview**](FlowPreview.md) | preview | [required] |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_raw_script_dependencies

> models::RunRawScriptDependencies201Response run_raw_script_dependencies(workspace, run_raw_script_dependencies_request)
run a one-off dependencies job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**run_raw_script_dependencies_request** | [**RunRawScriptDependenciesRequest**](RunRawScriptDependenciesRequest.md) | raw script content | [required] |

### Return type

[**models::RunRawScriptDependencies201Response**](runRawScriptDependencies_201_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_raw_script_dependencies_async

> uuid::Uuid run_raw_script_dependencies_async(workspace, run_raw_script_dependencies_request)
queue a one-off dependencies job and return the job uuid

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**run_raw_script_dependencies_request** | [**RunRawScriptDependenciesRequest**](RunRawScriptDependenciesRequest.md) | raw script content | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_by_hash

> uuid::Uuid run_script_by_hash(workspace, hash, body, scheduled_for, scheduled_in_secs, skip_preprocessor, parent_job, tag, cache_ttl, job_id, include_header, invisible_to_owner)
run script by hash

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**hash** | **String** |  | [required] |
**body** | **serde_json::Value** | Partially filled args | [required] |
**scheduled_for** | Option<**String**> | when to schedule this job (leave empty for immediate run) |  |
**scheduled_in_secs** | Option<**i32**> | schedule the script to execute in the number of seconds starting now |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the script owner (default false) |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_by_hash_inline

> serde_json::Value run_script_by_hash_inline(workspace, hash, inline_script_args)
run script by hash without starting a new job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**hash** | **String** |  | [required] |
**inline_script_args** | [**InlineScriptArgs**](InlineScriptArgs.md) | script args | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_by_path

> uuid::Uuid run_script_by_path(workspace, path, request_body, scheduled_for, scheduled_in_secs, skip_preprocessor, parent_job, tag, cache_ttl, job_id, invisible_to_owner)
run script by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**scheduled_for** | Option<**String**> | when to schedule this job (leave empty for immediate run) |  |
**scheduled_in_secs** | Option<**i32**> | schedule the script to execute in the number of seconds starting now |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the script owner (default false) |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_by_path_inline

> serde_json::Value run_script_by_path_inline(workspace, path, inline_script_args)
run script by path without starting a new job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**inline_script_args** | [**InlineScriptArgs**](InlineScriptArgs.md) | script args | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_preview

> uuid::Uuid run_script_preview(workspace, preview, include_header, invisible_to_owner, job_id)
run script preview

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**preview** | [**Preview**](Preview.md) | preview | [required] |
**include_header** | Option<**String**> | 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  |  |
**invisible_to_owner** | Option<**bool**> | make the run invisible to the the script owner (default false) |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_preview_and_wait_result

> serde_json::Value run_script_preview_and_wait_result(workspace, preview)
run script preview and wait for result

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**preview** | [**Preview**](Preview.md) | preview | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_script_preview_inline

> serde_json::Value run_script_preview_inline(workspace, preview_inline)
run script preview without starting a new job

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**preview_inline** | [**PreviewInline**](PreviewInline.md) | preview | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_wait_result_flow_by_path

> serde_json::Value run_wait_result_flow_by_path(workspace, path, request_body, include_header, queue_limit, job_id, skip_preprocessor, memory_id)
run flow by path and wait until completion

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_wait_result_flow_by_version

> serde_json::Value run_wait_result_flow_by_version(workspace, version, request_body, include_header, queue_limit, job_id, skip_preprocessor, memory_id)
run flow by version and wait until completion

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **i64** | flow version ID | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_wait_result_flow_by_version_get

> serde_json::Value run_wait_result_flow_by_version_get(workspace, version, include_header, queue_limit, payload, job_id, skip_preprocessor, memory_id)
run flow by version with GET and wait until completion

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **i64** | flow version ID | [required] |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |
**memory_id** | Option<**uuid::Uuid**> | memory ID for chat-enabled flows |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_wait_result_script_by_path

> serde_json::Value run_wait_result_script_by_path(workspace, path, request_body, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, skip_preprocessor)
run script by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | script args | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_wait_result_script_by_path_get

> serde_json::Value run_wait_result_script_by_path_get(workspace, path, parent_job, tag, cache_ttl, job_id, include_header, queue_limit, payload, skip_preprocessor)
run script by path with get

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**tag** | Option<**String**> | Override the tag to use |  |
**cache_ttl** | Option<**String**> | Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl |  |
**job_id** | Option<**uuid::Uuid**> | 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) |  |
**include_header** | Option<**String**> | 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  |  |
**queue_limit** | Option<**String**> | The maximum size of the queue for which the request would get rejected if that job would push it above that limit  |  |
**payload** | Option<**String**> | 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})))`  |  |
**skip_preprocessor** | Option<**bool**> | skip the preprocessor |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_flow_user_state

> String set_flow_user_state(workspace, id, key, body)
set flow user state at a given key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**key** | **String** |  | [required] |
**body** | Option<**serde_json::Value**> | new value | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

