2026-02-16

2026-03-17 15:25:32 -06:00
parent d5dd373de0
commit 60100fbab2
560 changed files with 33397 additions and 20776 deletions
@@ -0,0 +1,23 @@
+# AssignedTask
+
+AssignedTask is a task as it is received by the Worker.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **str** |  | 
+**job** | **str** |  | 
+**name** | **str** |  | 
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**priority** | **int** |  | 
+**job_priority** | **int** |  | 
+**job_type** | **str** |  | 
+**task_type** | **str** |  | 
+**commands** | [**[Command]**](Command.md) |  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# AssignedWorker
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**uuid** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,25 @@
+# AvailableJobSetting
+
+Single setting of a Job types.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Identifier for the setting, must be unique within the job type. | 
+**type** | [**AvailableJobSettingType**](AvailableJobSettingType.md) |  | 
+**subtype** | [**AvailableJobSettingSubtype**](AvailableJobSettingSubtype.md) |  | [optional] 
+**choices** | **[str]** | When given, limit the valid values to these choices. Only usable with string type. | [optional] 
+**propargs** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Any extra arguments to the bpy.props.SomeProperty() call used to create this property. | [optional] 
+**description** | **bool, date, datetime, dict, float, int, list, str, none_type** | The description/tooltip shown in the user interface. | [optional] 
+**label** | **bool, date, datetime, dict, float, int, list, str, none_type** | Label for displaying this setting. If not specified, the key is used to generate a reasonable label. | [optional] 
+**default** | **bool, date, datetime, dict, float, int, list, str, none_type** | The default value shown to the user when determining this setting. | [optional] 
+**eval** | **str** | Python expression to be evaluated in order to determine the default value for this setting. | [optional] 
+**eval_info** | [**AvailableJobSettingEvalInfo**](AvailableJobSettingEvalInfo.md) |  | [optional] 
+**visible** | [**AvailableJobSettingVisibility**](AvailableJobSettingVisibility.md) |  | [optional] 
+**required** | **bool** | Whether to immediately reject a job definition, of this type, without this particular setting.  | [optional]  if omitted the server will use the default value of False
+**editable** | **bool** | Whether to allow editing this setting after the job has been submitted. Would imply deleting all existing tasks for this job, and recompiling it.  | [optional]  if omitted the server will use the default value of False
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# AvailableJobSettingEvalInfo
+
+Meta-data for the 'eval' expression.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**show_link_button** | **bool** | Enables the &#39;eval on submit&#39; toggle button behavior for this setting. A toggle button will be shown in Blender&#39;s submission interface. When toggled on, the &#x60;eval&#x60; expression will determine the setting&#39;s value. Manually editing the setting is then no longer possible, and instead of an input field, the &#39;description&#39; string is shown. An example use is the to-be-rendered frame range, which by default automatically follows the scene range, but can be overridden manually when desired.  | defaults to False
+**description** | **str** | Description of what the &#39;eval&#39; expression is doing. It is also used as placeholder text to show when the manual input field is hidden (because eval-on-submit has been toggled on by the user).  | defaults to ""
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# AvailableJobSettingSubtype
+
+Sub-type of the job setting. Currently only available for string types. `HASHED_FILE_PATH` is a directory path + `\"/######\"` appended. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Sub-type of the job setting. Currently only available for string types. &#x60;HASHED_FILE_PATH&#x60; is a directory path + &#x60;\&quot;/######\&quot;&#x60; appended.  |  must be one of ["file_path", "dir_path", "file_name", "hashed_file_path", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# AvailableJobSettingType
+
+Type of job setting, must be usable as IDProperty type in Blender. No nested structures (arrays, dictionaries) are supported. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Type of job setting, must be usable as IDProperty type in Blender. No nested structures (arrays, dictionaries) are supported.  |  must be one of ["string", "int32", "float", "bool", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# AvailableJobSettingVisibility
+
+When to show this setting. `visible`: always show. `submission`: only show in the UI of a job submitter (like a Blender add-on). `web`: only show in the web interface for management, but not when submitting the job. `hidden`: never show; only available to the job compiler script as internal setting. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | When to show this setting. &#x60;visible&#x60;: always show. &#x60;submission&#x60;: only show in the UI of a job submitter (like a Blender add-on). &#x60;web&#x60;: only show in the web interface for management, but not when submitting the job. &#x60;hidden&#x60;: never show; only available to the job compiler script as internal setting.  | defaults to "visible",  must be one of ["visible", "hidden", "submission", "web", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,17 @@
+# AvailableJobType
+
+Job type supported by this Manager, and its parameters.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**label** | **str** |  | 
+**settings** | [**[AvailableJobSetting]**](AvailableJobSetting.md) |  | 
+**etag** | **str** | Hash of the job type. If the job settings or the label change, this etag will change. This is used on job submission to ensure that the submitted job settings are up to date.  | 
+**description** | **str** | The description/tooltip shown in the user interface. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# AvailableJobTypes
+
+List of job types supported by this Manager.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_types** | [**[AvailableJobType]**](AvailableJobType.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# BlenderPathCheckResult
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **str** | The input that was given to find this Blender. | 
+**path** | **str** | The path that was found. | 
+**source** | [**BlenderPathSource**](BlenderPathSource.md) |  | 
+**is_usable** | **bool** | Whether the path is usable or not. | 
+**cause** | **str** | Description of why this path is (not) usable. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# BlenderPathFindResult
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**[BlenderPathCheckResult]**](BlenderPathCheckResult.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# BlenderPathSource
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["file_association", "path_envvar", "system_location", "input_path", "default", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# Command
+
+Command represents a single command to execute by the Worker.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**parameters** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** |  | 
+**total_step_count** | **int** | Number of steps this command executes. This has to be implemented in the command&#39;s implementation on the Worker (to recognise what a \&quot;step\&quot; is), as well as given in the authoring code of the job type JavaScript script (to indicate how many steps the command invocation will perform). If not given, or set to 0, the command is not expected to send any step progress. In this case, the Worker will send a step update at completion of the command.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# Error
+
+Generic error response.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **int** | HTTP status code of this response. Is included in the payload so that a single object represents all error information. Code 503 is used when the database is busy. The HTTP response will contain a &#39;Retry-After&#39; HTTP header that indicates after which time the request can be retried. Following the header is not mandatory, and it&#39;s up to the client to do something reasonable like exponential backoff.  | 
+**message** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# EventFarmStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **FarmStatusReport** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,24 @@
+# EventJobUpdate
+
+Subset of a Job, sent over SocketIO/MQTT when a job changes. For new jobs, `previous_status` will be excluded. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | UUID of the Job | 
+**updated** | **datetime** | Timestamp of last update | 
+**status** | [**JobStatus**](JobStatus.md) |  | 
+**type** | **str** |  | 
+**refresh_tasks** | **bool** | Indicates that the client should refresh all the job&#39;s tasks. This is sent for mass updates, where updating each individual task would generate too many updates to be practical.  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**priority** | **int** |  | defaults to 50
+**name** | **str** | Name of the job | [optional] 
+**previous_status** | [**JobStatus**](JobStatus.md) |  | [optional] 
+**delete_requested_at** | **datetime** | If job deletion was requested, this is the timestamp at which that request was stored on Flamenco Manager.  | [optional] 
+**was_deleted** | **bool** | When a job was just deleted, this is set to &#x60;true&#x60;. If this is specified, only the &#39;id&#39; field is set, the rest will be empty.  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# EventLastRenderedUpdate
+
+Indicator that the last-rendered image of this job was updated.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **str** |  | 
+**thumbnail** | [**JobLastRenderedImageInfo**](JobLastRenderedImageInfo.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# EventLifeCycle
+
+Flamenco life-cycle event, for things like shutting down, starting up, etc. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**LifeCycleEventType**](LifeCycleEventType.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# EventTaskLogUpdate
+
+Task log chunk, sent to a MQTT topic/SocketIO room dedicated to a single task, to avoid sending too many updates. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **str** | UUID of the Task | 
+**log** | **str** | Chunk of the task log. May contain multiple lines of text. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,22 @@
+# EventTaskUpdate
+
+Subset of a Task, sent over SocketIO/MQTT when a task changes. For new tasks, `previous_status` will be excluded. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | UUID of the Task | 
+**job_id** | **str** |  | 
+**name** | **str** | Name of the task | 
+**updated** | **datetime** | Timestamp of last update | 
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**activity** | **str** |  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**worker** | [**AssignedWorker**](AssignedWorker.md) |  | [optional] 
+**previous_status** | [**TaskStatus**](TaskStatus.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# EventWorkerTagUpdate
+
+Worker Tag, sent over SocketIO/MQTT when it changes. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | [**WorkerTag**](WorkerTag.md) |  | 
+**was_deleted** | **bool** | When a tag was just deleted, this is set to &#x60;true&#x60;. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,22 @@
+# EventWorkerUpdate
+
+Subset of a Worker, sent over SocketIO/MQTT when a worker changes. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | UUID of the Worker | 
+**name** | **str** | Name of the worker | 
+**updated** | **datetime** | Timestamp of last update | 
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**version** | **str** |  | 
+**can_restart** | **bool** | Whether this Worker can auto-restart. | 
+**last_seen** | **datetime** | Last time this worker was seen by the Manager. | [optional] 
+**previous_status** | [**WorkerStatus**](WorkerStatus.md) |  | [optional] 
+**status_change** | [**WorkerStatusChangeRequest**](WorkerStatusChangeRequest.md) |  | [optional] 
+**deleted_at** | **datetime** | This is only set when the worker was deleted. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# FarmStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["active", "idle", "waiting", "asleep", "inoperative", "unknown", "starting", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# FarmStatusReport
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**FarmStatus**](FarmStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# FlamencoVersion
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **str** | Version of this Manager, meant for human consumption. For release builds it is the same as &#x60;shortversion&#x60;, for other builds it also includes the &#x60;git&#x60; version info.  | 
+**shortversion** | **str** |  | 
+**name** | **str** |  | 
+**git** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,29 @@
+# Job
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**type** | **str** |  | 
+**submitter_platform** | **str** | Operating system of the submitter. This is used to recognise two-way variables. This should be a lower-case version of the platform, like \&quot;linux\&quot;, \&quot;windows\&quot;, \&quot;darwin\&quot;, \&quot;openbsd\&quot;, etc. Should be ompatible with Go&#39;s &#x60;runtime.GOOS&#x60;; run &#x60;go tool dist list&#x60; to get a list of possible platforms. As a special case, the platform \&quot;manager\&quot; can be given, which will be interpreted as \&quot;the Manager&#39;s platform\&quot;. This is mostly to make test/debug scripts easier, as they can use a static document on all platforms.  | 
+**id** | **str** | UUID of the Job | 
+**created** | **datetime** | Creation timestamp | 
+**updated** | **datetime** | Timestamp of last update. | 
+**status** | [**JobStatus**](JobStatus.md) |  | 
+**activity** | **str** | Description of the last activity on this job. | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**priority** | **int** |  | defaults to 50
+**type_etag** | **str** | Hash of the job type, copied from the &#x60;AvailableJobType.etag&#x60; property of the job type. The job will be rejected if this field doesn&#39;t match the actual job type on the Manager. This prevents job submission with old settings, after the job compiler script has been updated. If this field is omitted, the check is bypassed.  | [optional] 
+**settings** | [**JobSettings**](JobSettings.md) |  | [optional] 
+**metadata** | [**JobMetadata**](JobMetadata.md) |  | [optional] 
+**storage** | [**JobStorageInfo**](JobStorageInfo.md) |  | [optional] 
+**worker_tag** | **str** | Worker tag that should execute this job. When a tag ID is given, only Workers in that tag will be scheduled to work on it. If empty or omitted, all workers can work on this job.  | [optional] 
+**initial_status** | [**JobStatus**](JobStatus.md) |  | [optional] 
+**delete_requested_at** | **datetime** | If job deletion was requested, this is the timestamp at which that request was stored on Flamenco Manager.  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,19 @@
+# JobAllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | UUID of the Job | 
+**created** | **datetime** | Creation timestamp | 
+**updated** | **datetime** | Timestamp of last update. | 
+**status** | [**JobStatus**](JobStatus.md) |  | 
+**activity** | **str** | Description of the last activity on this job. | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**delete_requested_at** | **datetime** | If job deletion was requested, this is the timestamp at which that request was stored on Flamenco Manager.  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# JobBlocklist
+
+List of workers that are not allowed certain task types on a specific job.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**[JobBlocklistEntry]**](JobBlocklistEntry.md) | List of workers that are not allowed certain task types on a specific job. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# JobBlocklistEntry
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**worker_id** | **str** |  | 
+**task_type** | **str** |  | 
+**worker_name** | **str** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# JobDeletionInfo
+
+Info about what will be deleted when this job is deleted.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shaman_checkout** | **bool** | Whether the Shaman checkout directory will be removed along with the job. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# JobLastRenderedImageInfo
+
+Enough information for a client to piece together different strings to form a host-relative URL to the last-rendered image. To construct the URL, concatenate \"{base}/{one of the suffixes}\". 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base** | **str** |  | 
+**suffixes** | **[str]** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# JobMassDeletionSelection
+
+Parameters to describe which jobs should be deleted.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_updated_max** | **datetime** | All jobs that were last updated before or on this timestamp will be deleted. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# JobMetadata
+
+Arbitrary metadata strings. More complex structures can be modeled by using `a.b.c` notation for the key.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**any string name** | **str** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# JobPriorityChange
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priority** | **int** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# JobSettings
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# JobStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["active", "canceled", "completed", "failed", "paused", "pause-requested", "queued", "cancel-requested", "requeueing", "under-construction", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# JobStatusChange
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**JobStatus**](JobStatus.md) |  | 
+**reason** | **str** | The reason for this status change. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# JobStorageInfo
+
+Storage info of a job, which Flamenco can use to remove job-related files when necessary. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shaman_checkout_id** | **str** | &#39;Checkout ID&#39; used when creating the Shaman checkout for this job. Aids in removing the checkout directory when the job is removed from Flamenco.  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# JobTagChange
+
+New tag to assign to a job. Can be empty to remove the tag (and thus make the job available to all workers).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | UUID of the tag. If this is given, &#39;name&#39; should not be given. | [optional] 
+**name** | **str** | Name of the tag. If this is given, &#39;id&#39; should not be given. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# JobTasksSummary
+
+Simplified list of tasks of a job. Contains all tasks, but not all info of each task.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tasks** | [**[TaskSummary]**](TaskSummary.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,17 @@
+# JobsQuery
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offset** | **int** |  | [optional] 
+**limit** | **int** |  | [optional] 
+**order_by** | **[str]** |  | [optional] 
+**status_in** | [**[JobStatus]**](JobStatus.md) | Return only jobs with a status in this array. | [optional] 
+**metadata** | **{str: (str,)}** | Filter by metadata, using &#x60;LIKE&#x60; notation. | [optional] 
+**settings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Filter by job settings, using &#x60;LIKE&#x60; notation. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# JobsQueryResult
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobs** | [**[Job]**](Job.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# LifeCycleEventType
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["manager-startup", "manager-shutdown", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# ManagerConfiguration
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage_location** | **str** | Directory used for job file storage. | 
+**shaman_enabled** | **bool** | Whether the Shaman file transfer API is available. | 
+**is_first_run** | **bool** | Whether this is considered the first time the Manager runs. This is determined by a few factors, like a non-existent configuration file or certain settings being empty while they shouldn&#39;t be.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# ManagerVariable
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  | 
+**is_twoway** | **bool** | One-way variables are the most common one, and are simple replacement from &#x60;{name}&#x60; to their value, which happens when a Task is given to a Worker. Two-way variables are also replaced when submitting a job, where the platform-specific value is replaced by &#x60;{name}&#x60;.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# ManagerVariableAudience
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["workers", "users", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# ManagerVariables
+
+Mapping from variable name to its properties.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**any string name** | [**ManagerVariable**](ManagerVariable.md) | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# MayKeepRunning
+
+Indicates whether the worker may keep running the task.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**may_keep_running** | **bool** |  | 
+**reason** | **str** |  | 
+**status_change_requested** | **bool** | Indicates that a status change requested for the worker. It should use the &#x60;workerState&#x60; operation to determine which state to go to next. If this is &#x60;true&#x60;, &#x60;mayKeepRunning&#x60; MUST be &#x60;false&#x60;.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,744 @@
+# flamenco.manager.MetaApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**check_blender_exe_path**](MetaApi.md#check_blender_exe_path) | **POST** /api/v3/configuration/check/blender | Validate a CLI command for use as way to start Blender
+[**check_shared_storage_path**](MetaApi.md#check_shared_storage_path) | **POST** /api/v3/configuration/check/shared-storage | Validate a path for use as shared storage.
+[**find_blender_exe_path**](MetaApi.md#find_blender_exe_path) | **GET** /api/v3/configuration/check/blender | Find one or more CLI commands for use as way to start Blender
+[**get_configuration**](MetaApi.md#get_configuration) | **GET** /api/v3/configuration | Get the configuration of this Manager.
+[**get_configuration_file**](MetaApi.md#get_configuration_file) | **GET** /api/v3/configuration/file | Retrieve the configuration of Flamenco Manager.
+[**get_farm_status**](MetaApi.md#get_farm_status) | **GET** /api/v3/status | Get the status of this Flamenco farm.
+[**get_shared_storage**](MetaApi.md#get_shared_storage) | **GET** /api/v3/configuration/shared-storage/{audience}/{platform} | Get the shared storage location of this Manager, adjusted for the given audience and platform. 
+[**get_variables**](MetaApi.md#get_variables) | **GET** /api/v3/configuration/variables/{audience}/{platform} | Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser&#39;s platform. 
+[**get_version**](MetaApi.md#get_version) | **GET** /api/v3/version | Get the Flamenco version of this Manager
+[**save_setup_assistant_config**](MetaApi.md#save_setup_assistant_config) | **POST** /api/v3/configuration/setup-assistant | Update the Manager&#39;s configuration, and restart it in fully functional mode.
+[**update_configuration_file**](MetaApi.md#update_configuration_file) | **PUT** /api/v3/configuration/file | Overwrites the configuration file. It does not actively reload the new configuration.
+
+
+# **check_blender_exe_path**
+> BlenderPathCheckResult check_blender_exe_path()
+
+Validate a CLI command for use as way to start Blender
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.path_check_input import PathCheckInput
+from flamenco.manager.model.blender_path_check_result import BlenderPathCheckResult
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    path_check_input = PathCheckInput(
+        path="path_example",
+    ) # PathCheckInput | Command or executable path to check (optional)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Validate a CLI command for use as way to start Blender
+        api_response = api_instance.check_blender_exe_path(path_check_input=path_check_input)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->check_blender_exe_path: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path_check_input** | [**PathCheckInput**](PathCheckInput.md)| Command or executable path to check | [optional]
+
+### Return type
+
+[**BlenderPathCheckResult**](BlenderPathCheckResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response, path check went fine. |  -  |
+**0** | Something went wrong. |  -  |
+
+[[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)
+
+# **check_shared_storage_path**
+> PathCheckResult check_shared_storage_path()
+
+Validate a path for use as shared storage.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.path_check_result import PathCheckResult
+from flamenco.manager.model.path_check_input import PathCheckInput
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    path_check_input = PathCheckInput(
+        path="path_example",
+    ) # PathCheckInput | Path to check (optional)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Validate a path for use as shared storage.
+        api_response = api_instance.check_shared_storage_path(path_check_input=path_check_input)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->check_shared_storage_path: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path_check_input** | [**PathCheckInput**](PathCheckInput.md)| Path to check | [optional]
+
+### Return type
+
+[**PathCheckResult**](PathCheckResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response, path check went fine. |  -  |
+**0** | Something went wrong. |  -  |
+
+[[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)
+
+# **find_blender_exe_path**
+> BlenderPathFindResult find_blender_exe_path()
+
+Find one or more CLI commands for use as way to start Blender
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.blender_path_find_result import BlenderPathFindResult
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Find one or more CLI commands for use as way to start Blender
+        api_response = api_instance.find_blender_exe_path()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->find_blender_exe_path: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BlenderPathFindResult**](BlenderPathFindResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Found locations of Blender. |  -  |
+**0** | Something went wrong. |  -  |
+
+[[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_configuration**
+> ManagerConfiguration get_configuration()
+
+Get the configuration of this Manager.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.manager_configuration import ManagerConfiguration
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Get the configuration of this Manager.
+        api_response = api_instance.get_configuration()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_configuration: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ManagerConfiguration**](ManagerConfiguration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+
+[[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_configuration_file**
+> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_configuration_file()
+
+Retrieve the configuration of Flamenco Manager.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Retrieve the configuration of Flamenco Manager.
+        api_response = api_instance.get_configuration_file()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_configuration_file: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response. |  -  |
+
+[[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_farm_status**
+> FarmStatusReport get_farm_status()
+
+Get the status of this Flamenco farm.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.farm_status_report import FarmStatusReport
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Get the status of this Flamenco farm.
+        api_response = api_instance.get_farm_status()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_farm_status: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FarmStatusReport**](FarmStatusReport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+
+[[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_shared_storage**
+> SharedStorageLocation get_shared_storage(audience, platform)
+
+Get the shared storage location of this Manager, adjusted for the given audience and platform. 
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.manager_variable_audience import ManagerVariableAudience
+from flamenco.manager.model.shared_storage_location import SharedStorageLocation
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    audience = ManagerVariableAudience("workers") # ManagerVariableAudience | 
+    platform = "platform_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Get the shared storage location of this Manager, adjusted for the given audience and platform. 
+        api_response = api_instance.get_shared_storage(audience, platform)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_shared_storage: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **audience** | **ManagerVariableAudience**|  |
+ **platform** | **str**|  |
+
+### Return type
+
+[**SharedStorageLocation**](SharedStorageLocation.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response. |  -  |
+
+[[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_variables**
+> ManagerVariables get_variables(audience, platform)
+
+Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform. 
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.manager_variable_audience import ManagerVariableAudience
+from flamenco.manager.model.manager_variables import ManagerVariables
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    audience = ManagerVariableAudience("workers") # ManagerVariableAudience | 
+    platform = "platform_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform. 
+        api_response = api_instance.get_variables(audience, platform)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_variables: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **audience** | **ManagerVariableAudience**|  |
+ **platform** | **str**|  |
+
+### Return type
+
+[**ManagerVariables**](ManagerVariables.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response. |  -  |
+
+[[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_version**
+> FlamencoVersion get_version()
+
+Get the Flamenco version of this Manager
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.flamenco_version import FlamencoVersion
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Get the Flamenco version of this Manager
+        api_response = api_instance.get_version()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->get_version: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FlamencoVersion**](FlamencoVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+
+[[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)
+
+# **save_setup_assistant_config**
+> save_setup_assistant_config()
+
+Update the Manager's configuration, and restart it in fully functional mode.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.setup_assistant_config import SetupAssistantConfig
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    setup_assistant_config = SetupAssistantConfig(
+        storage_location="storage_location_example",
+        blender_executable=BlenderPathCheckResult(
+            input="input_example",
+            path="path_example",
+            source=BlenderPathSource("file_association"),
+            is_usable=True,
+            cause="cause_example",
+        ),
+    ) # SetupAssistantConfig | Configuration to save. (optional)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Update the Manager's configuration, and restart it in fully functional mode.
+        api_instance.save_setup_assistant_config(setup_assistant_config=setup_assistant_config)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->save_setup_assistant_config: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **setup_assistant_config** | [**SetupAssistantConfig**](SetupAssistantConfig.md)| Configuration to save. | [optional]
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Normal response. The webapp should do a full refresh at this point. |  -  |
+**0** | Something went wrong. |  -  |
+
+[[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)
+
+# **update_configuration_file**
+> update_configuration_file(body)
+
+Overwrites the configuration file. It does not actively reload the new configuration.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import meta_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = meta_api.MetaApi(api_client)
+    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | The configuration values as a JSON
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Overwrites the configuration file. It does not actively reload the new configuration.
+        api_instance.update_configuration_file(body)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling MetaApi->update_configuration_file: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| The configuration values as a JSON |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The configuration was successfully stored to flamenco-manager.yaml |  -  |
+**0** | Unable to save the configuration file |  -  |
+
+[[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)
+
@@ -0,0 +1,12 @@
+# PathCheckInput
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# PathCheckResult
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **str** | The path that was checked. | 
+**is_usable** | **bool** | Whether the path is usable or not. | 
+**cause** | **str** | Description of why this path is (not) usable. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,18 @@
+# RegisteredWorker
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **str** |  | 
+**name** | **str** |  | 
+**address** | **str** |  | 
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**platform** | **str** |  | 
+**software** | **str** |  | 
+**supported_task_types** | **[str]** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# SecurityError
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# SetupAssistantConfig
+
+Configuration obtained from the Setup Assistant.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage_location** | **str** | Directory used for job file storage. | 
+**blender_executable** | [**BlenderPathCheckResult**](BlenderPathCheckResult.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,320 @@
+# flamenco.manager.ShamanApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**shaman_checkout**](ShamanApi.md#shaman_checkout) | **POST** /api/v3/shaman/checkout/create | Create a directory, and symlink the required files into it. The files must all have been uploaded to Shaman before calling this endpoint.
+[**shaman_checkout_requirements**](ShamanApi.md#shaman_checkout_requirements) | **POST** /api/v3/shaman/checkout/requirements | Checks a Shaman Requirements file, and reports which files are unknown.
+[**shaman_file_store**](ShamanApi.md#shaman_file_store) | **POST** /api/v3/shaman/files/{checksum}/{filesize} | Store a new file on the Shaman server. Note that the Shaman server can forcibly close the HTTP connection when another client finishes uploading the exact same file, to prevent double uploads. The file&#39;s contents should be sent in the request body. 
+[**shaman_file_store_check**](ShamanApi.md#shaman_file_store_check) | **GET** /api/v3/shaman/files/{checksum}/{filesize} | Check the status of a file on the Shaman server. 
+
+
+# **shaman_checkout**
+> ShamanCheckoutResult shaman_checkout(shaman_checkout)
+
+Create a directory, and symlink the required files into it. The files must all have been uploaded to Shaman before calling this endpoint.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import shaman_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.shaman_checkout import ShamanCheckout
+from flamenco.manager.model.shaman_checkout_result import ShamanCheckoutResult
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = shaman_api.ShamanApi(api_client)
+    shaman_checkout = ShamanCheckout(
+        files=[
+            ShamanFileSpec(
+                sha="sha_example",
+                size=1,
+                path="path_example",
+            ),
+        ],
+        checkout_path="checkout_path_example",
+    ) # ShamanCheckout | Set of files to check out.
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Create a directory, and symlink the required files into it. The files must all have been uploaded to Shaman before calling this endpoint.
+        api_response = api_instance.shaman_checkout(shaman_checkout)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling ShamanApi->shaman_checkout: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shaman_checkout** | [**ShamanCheckout**](ShamanCheckout.md)| Set of files to check out. |
+
+### Return type
+
+[**ShamanCheckoutResult**](ShamanCheckoutResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Checkout was created successfully. |  -  |
+**424** | There were files missing. Use &#x60;shamanCheckoutRequirements&#x60; to figure out which ones. |  -  |
+**409** | Checkout already exists. |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **shaman_checkout_requirements**
+> ShamanRequirementsResponse shaman_checkout_requirements(shaman_requirements_request)
+
+Checks a Shaman Requirements file, and reports which files are unknown.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import shaman_api
+from flamenco.manager.model.shaman_requirements_request import ShamanRequirementsRequest
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.shaman_requirements_response import ShamanRequirementsResponse
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = shaman_api.ShamanApi(api_client)
+    shaman_requirements_request = ShamanRequirementsRequest(
+        files=[
+            ShamanFileSpec(
+                sha="sha_example",
+                size=1,
+                path="path_example",
+            ),
+        ],
+    ) # ShamanRequirementsRequest | Set of files to check
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Checks a Shaman Requirements file, and reports which files are unknown.
+        api_response = api_instance.shaman_checkout_requirements(shaman_requirements_request)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling ShamanApi->shaman_checkout_requirements: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shaman_requirements_request** | [**ShamanRequirementsRequest**](ShamanRequirementsRequest.md)| Set of files to check |
+
+### Return type
+
+[**ShamanRequirementsResponse**](ShamanRequirementsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Subset of the posted requirements, indicating the unknown files. |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **shaman_file_store**
+> shaman_file_store(checksum, filesize, body)
+
+Store a new file on the Shaman server. Note that the Shaman server can forcibly close the HTTP connection when another client finishes uploading the exact same file, to prevent double uploads. The file's contents should be sent in the request body. 
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import shaman_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = shaman_api.ShamanApi(api_client)
+    checksum = "checksum_example" # str | SHA256 checksum of the file.
+    filesize = 1 # int | Size of the file in bytes.
+    body = open('/path/to/file', 'rb') # file_type | Contents of the file
+    x_shaman_can_defer_upload = True # bool | The client indicates that it can defer uploading this file. The \"208\" response will not only be returned when the file is already fully known to the Shaman server, but also when someone else is currently uploading this file.  (optional)
+    x_shaman_original_filename = "X-Shaman-Original-Filename_example" # str | The original filename. If sent along with the request, it will be included in the server logs, which can aid in debugging. MUST either be ASCII or encoded using RFC 2047 (aka MIME encoding). In the latter case the encoding MUST be UTF-8.  (optional)
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Store a new file on the Shaman server. Note that the Shaman server can forcibly close the HTTP connection when another client finishes uploading the exact same file, to prevent double uploads. The file's contents should be sent in the request body. 
+        api_instance.shaman_file_store(checksum, filesize, body)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling ShamanApi->shaman_file_store: %s\n" % e)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Store a new file on the Shaman server. Note that the Shaman server can forcibly close the HTTP connection when another client finishes uploading the exact same file, to prevent double uploads. The file's contents should be sent in the request body. 
+        api_instance.shaman_file_store(checksum, filesize, body, x_shaman_can_defer_upload=x_shaman_can_defer_upload, x_shaman_original_filename=x_shaman_original_filename)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling ShamanApi->shaman_file_store: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **checksum** | **str**| SHA256 checksum of the file. |
+ **filesize** | **int**| Size of the file in bytes. |
+ **body** | **file_type**| Contents of the file |
+ **x_shaman_can_defer_upload** | **bool**| The client indicates that it can defer uploading this file. The \&quot;208\&quot; response will not only be returned when the file is already fully known to the Shaman server, but also when someone else is currently uploading this file.  | [optional]
+ **x_shaman_original_filename** | **str**| The original filename. If sent along with the request, it will be included in the server logs, which can aid in debugging. MUST either be ASCII or encoded using RFC 2047 (aka MIME encoding). In the latter case the encoding MUST be UTF-8.  | [optional]
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/octet-stream
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The file was accepted. |  -  |
+**208** | The file was already known to the server. |  -  |
+**417** | There was a mismatch between the request parameters and the actual file size or checksum of the uploaded file.  |  -  |
+**425** | Client should defer uploading this file. The file is currently in the process of being uploaded by someone else, and &#x60;X-Shaman-Can-Defer-Upload: true&#x60; was sent in the request.  |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **shaman_file_store_check**
+> ShamanSingleFileStatus shaman_file_store_check(checksum, filesize)
+
+Check the status of a file on the Shaman server. 
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import shaman_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.shaman_single_file_status import ShamanSingleFileStatus
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = shaman_api.ShamanApi(api_client)
+    checksum = "checksum_example" # str | SHA256 checksum of the file.
+    filesize = 1 # int | Size of the file in bytes.
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Check the status of a file on the Shaman server. 
+        api_response = api_instance.shaman_file_store_check(checksum, filesize)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling ShamanApi->shaman_file_store_check: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **checksum** | **str**| SHA256 checksum of the file. |
+ **filesize** | **int**| Size of the file in bytes. |
+
+### Return type
+
+[**ShamanSingleFileStatus**](ShamanSingleFileStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response. |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
@@ -0,0 +1,14 @@
+# ShamanCheckout
+
+Set of files with their SHA256 checksum, size in bytes, and desired location in the checkout directory.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**files** | [**[ShamanFileSpec]**](ShamanFileSpec.md) |  | 
+**checkout_path** | **str** | Path where the Manager should create this checkout. It is relative to the Shaman checkout path as configured on the Manager. In older versions of the Shaman this was just the \&quot;checkout ID\&quot;, but in this version it can be a path like &#x60;project-slug/scene-name/unique-ID&#x60;.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# ShamanCheckoutResult
+
+The result of a Shaman checkout.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**checkout_path** | **str** | Path where the Manager created this checkout. This can be different than what was requested, as the Manager will ensure a unique directory. The path is relative to the Shaman checkout path as configured on the Manager.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# ShamanFileSpec
+
+Specification of a file in the Shaman storage.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sha** | **str** | SHA256 checksum of the file | 
+**size** | **int** | File size in bytes | 
+**path** | **str** | Location of the file in the checkout | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# ShamanFileSpecWithStatus
+
+Specification of a file, which could be in the Shaman storage, or not, depending on its status.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sha** | **str** | SHA256 checksum of the file | 
+**size** | **int** | File size in bytes | 
+**path** | **str** | Location of the file in the checkout | 
+**status** | [**ShamanFileStatus**](ShamanFileStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# ShamanFileStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["unknown", "uploading", "stored", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# ShamanRequirementsRequest
+
+Set of files with their SHA256 checksum and size in bytes.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**files** | [**[ShamanFileSpec]**](ShamanFileSpec.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# ShamanRequirementsResponse
+
+The files from a requirements request, with their status on the Shaman server. Files that are known to Shaman are excluded from the response.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**files** | [**[ShamanFileSpecWithStatus]**](ShamanFileSpecWithStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# ShamanSingleFileStatus
+
+Status of a file in the Shaman storage.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**ShamanFileStatus**](ShamanFileStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# SharedStorageLocation
+
+Location of the shared storage, adjusted for a specific audience & platform. This uses two-way variables to adjust the shared storage path from the Manager's configuration. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **str** |  | 
+**audience** | [**ManagerVariableAudience**](ManagerVariableAudience.md) |  | 
+**platform** | **str** |  | 
+**shaman_enabled** | **bool** | Whether the Shaman file transfer API is available. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# SocketIOSubscription
+
+Send by SocketIO clients as `/subscription` event type, to manage their subscription to job updates. Clients always get job updates, but for task updates or task logs they need to explicitly subscribe. For simplicity, clients can only subscribe to one job (to get task updates for that job) and one task's log at a time. This is not used by MQTT, as with that protocol the subscriptions are managed by the MQTT broker, not Flamenco. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**op** | [**SocketIOSubscriptionOperation**](SocketIOSubscriptionOperation.md) |  | 
+**type** | [**SocketIOSubscriptionType**](SocketIOSubscriptionType.md) |  | 
+**uuid** | **str** | UUID of the thing to subscribe to / unsubscribe from. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# SocketIOSubscriptionOperation
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["subscribe", "unsubscribe", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# SocketIOSubscriptionType
+
+What kind of thing to subscribe to / unsubscribe from.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | What kind of thing to subscribe to / unsubscribe from. |  must be one of ["allJobs", "allWorkers", "job", "tasklog", "allLastRendered", "allWorkerTags", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,22 @@
+# SubmittedJob
+
+Job definition submitted to Flamenco.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**type** | **str** |  | 
+**submitter_platform** | **str** | Operating system of the submitter. This is used to recognise two-way variables. This should be a lower-case version of the platform, like \&quot;linux\&quot;, \&quot;windows\&quot;, \&quot;darwin\&quot;, \&quot;openbsd\&quot;, etc. Should be ompatible with Go&#39;s &#x60;runtime.GOOS&#x60;; run &#x60;go tool dist list&#x60; to get a list of possible platforms. As a special case, the platform \&quot;manager\&quot; can be given, which will be interpreted as \&quot;the Manager&#39;s platform\&quot;. This is mostly to make test/debug scripts easier, as they can use a static document on all platforms.  | 
+**priority** | **int** |  | defaults to 50
+**type_etag** | **str** | Hash of the job type, copied from the &#x60;AvailableJobType.etag&#x60; property of the job type. The job will be rejected if this field doesn&#39;t match the actual job type on the Manager. This prevents job submission with old settings, after the job compiler script has been updated. If this field is omitted, the check is bypassed.  | [optional] 
+**settings** | [**JobSettings**](JobSettings.md) |  | [optional] 
+**metadata** | [**JobMetadata**](JobMetadata.md) |  | [optional] 
+**storage** | [**JobStorageInfo**](JobStorageInfo.md) |  | [optional] 
+**worker_tag** | **str** | Worker tag that should execute this job. When a tag ID is given, only Workers in that tag will be scheduled to work on it. If empty or omitted, all workers can work on this job.  | [optional] 
+**initial_status** | [**JobStatus**](JobStatus.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,28 @@
+# Task
+
+The task as it exists in the Manager database, i.e. before variable replacement.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**created** | **datetime** | Creation timestamp | 
+**updated** | **datetime** | Timestamp of last update. | 
+**job_id** | **str** |  | 
+**index_in_job** | **int** |  | 
+**name** | **str** |  | 
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**priority** | **int** |  | 
+**task_type** | **str** |  | 
+**activity** | **str** |  | 
+**commands** | [**[Command]**](Command.md) |  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**worker** | [**TaskWorker**](TaskWorker.md) |  | [optional] 
+**last_touched** | **datetime** | Timestamp of when any worker worked on this task. | [optional] 
+**failed_by_workers** | [**[TaskWorker]**](TaskWorker.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# TaskLogInfo
+
+Info about the log of a single task.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **str** |  | 
+**job_id** | **str** |  | 
+**url** | **str** | The URL at which the task log itself can be downloaded. | 
+**size** | **int** | The size of the task log, in bytes. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# TaskStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["active", "canceled", "completed", "failed", "queued", "soft-failed", "paused", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# TaskStatusChange
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**reason** | **str** | The reason for this status change. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,22 @@
+# TaskSummary
+
+Just enough information about the task to show in the job's task list.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**name** | **str** |  | 
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**index_in_job** | **int** |  | 
+**priority** | **int** |  | 
+**task_type** | **str** |  | 
+**updated** | **datetime** |  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**worker** | [**TaskWorker**](TaskWorker.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# TaskUpdate
+
+TaskUpdate is sent by a Worker to update the status & logs of a task it's executing. All properties are optional; omitted properties are ignored (i.e. omitting `activity` will not erase the activity property of the task). 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_status** | [**TaskStatus**](TaskStatus.md) |  | [optional] 
+**activity** | **str** | One-liner to indicate what&#39;s currently happening with the task. Overwrites previously sent activity strings. | [optional] 
+**log** | **str** | Log lines for this task, will be appended to logs sent earlier. | [optional] 
+**steps_completed** | **int** | Number of task steps completed. May not exceed the task&#39;s steps_total. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# TaskWorker
+
+Worker reference, as used in Task objects.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**name** | **str** |  | 
+**address** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,24 @@
+# Worker
+
+All information about a Worker
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**name** | **str** |  | 
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**version** | **str** | Version of Flamenco this Worker is running | 
+**can_restart** | **bool** | Whether this worker can auto-restart. | 
+**ip_address** | **str** | IP address of the Worker | 
+**platform** | **str** | Operating system of the Worker | 
+**supported_task_types** | **[str]** |  | 
+**status_change** | [**WorkerStatusChangeRequest**](WorkerStatusChangeRequest.md) |  | [optional] 
+**last_seen** | **datetime** | Last time this worker was seen by the Manager. | [optional] 
+**task** | [**WorkerTask**](WorkerTask.md) |  | [optional] 
+**tags** | [**[WorkerTag]**](WorkerTag.md) | Tags of which this Worker is a member. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# WorkerAllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip_address** | **str** | IP address of the Worker | 
+**platform** | **str** | Operating system of the Worker | 
+**supported_task_types** | **[str]** |  | 
+**task** | [**WorkerTask**](WorkerTask.md) |  | [optional] 
+**tags** | [**[WorkerTag]**](WorkerTag.md) | Tags of which this Worker is a member. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,726 @@
+# flamenco.manager.WorkerApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**may_worker_run**](WorkerApi.md#may_worker_run) | **GET** /api/v3/worker/task/{task_id}/may-i-run | The response indicates whether the worker is allowed to run / keep running the task. Optionally contains a queued worker status change. 
+[**register_worker**](WorkerApi.md#register_worker) | **POST** /api/v3/worker/register-worker | Register a new worker
+[**schedule_task**](WorkerApi.md#schedule_task) | **POST** /api/v3/worker/task | Obtain a new task to execute
+[**sign_off**](WorkerApi.md#sign_off) | **POST** /api/v3/worker/sign-off | Mark the worker as offline
+[**sign_on**](WorkerApi.md#sign_on) | **POST** /api/v3/worker/sign-on | Authenticate &amp; sign in the worker.
+[**task_output_produced**](WorkerApi.md#task_output_produced) | **POST** /api/v3/worker/task/{task_id}/output-produced | Store the most recently rendered frame here. Note that it is up to the Worker to ensure this is in a format that&#39;s digestable by the Manager. Currently only PNG and JPEG support is planned. 
+[**task_update**](WorkerApi.md#task_update) | **POST** /api/v3/worker/task/{task_id} | Update the task, typically to indicate progress, completion, or failure.
+[**worker_state**](WorkerApi.md#worker_state) | **GET** /api/v3/worker/state | 
+[**worker_state_changed**](WorkerApi.md#worker_state_changed) | **POST** /api/v3/worker/state-changed | Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals.
+
+
+# **may_worker_run**
+> MayKeepRunning may_worker_run(task_id)
+
+The response indicates whether the worker is allowed to run / keep running the task. Optionally contains a queued worker status change. 
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.may_keep_running import MayKeepRunning
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    task_id = "task_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # The response indicates whether the worker is allowed to run / keep running the task. Optionally contains a queued worker status change. 
+        api_response = api_instance.may_worker_run(task_id)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->may_worker_run: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **str**|  |
+
+### Return type
+
+[**MayKeepRunning**](MayKeepRunning.md)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **register_worker**
+> RegisteredWorker register_worker(worker_registration)
+
+Register a new worker
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_registration import WorkerRegistration
+from flamenco.manager.model.registered_worker import RegisteredWorker
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    worker_registration = WorkerRegistration(
+        secret="secret_example",
+        platform="platform_example",
+        supported_task_types=[
+            "supported_task_types_example",
+        ],
+        name="name_example",
+    ) # WorkerRegistration | Worker to register
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Register a new worker
+        api_response = api_instance.register_worker(worker_registration)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->register_worker: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_registration** | [**WorkerRegistration**](WorkerRegistration.md)| Worker to register |
+
+### Return type
+
+[**RegisteredWorker**](RegisteredWorker.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **schedule_task**
+> AssignedTask schedule_task()
+
+Obtain a new task to execute
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.worker_state_change import WorkerStateChange
+from flamenco.manager.model.security_error import SecurityError
+from flamenco.manager.model.assigned_task import AssignedTask
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Obtain a new task to execute
+        api_response = api_instance.schedule_task()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->schedule_task: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AssignedTask**](AssignedTask.md)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No tasks available for this Worker. |  -  |
+**200** | Task to execute. |  -  |
+**403** | Permission Denied |  -  |
+**409** | Worker is not in the active state, so is not allowed to execute tasks right now. |  -  |
+**423** | Worker cannot obtain new tasks, but must go to another state. |  -  |
+
+[[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)
+
+# **sign_off**
+> sign_off()
+
+Mark the worker as offline
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Mark the worker as offline
+        api_instance.sign_off()
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->sign_off: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | normal response |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **sign_on**
+> WorkerStateChange sign_on(worker_sign_on)
+
+Authenticate & sign in the worker.
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_state_change import WorkerStateChange
+from flamenco.manager.model.worker_sign_on import WorkerSignOn
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    worker_sign_on = WorkerSignOn(
+        name="name_example",
+        supported_task_types=[
+            "supported_task_types_example",
+        ],
+        software_version="software_version_example",
+        can_restart=True,
+    ) # WorkerSignOn | Worker metadata
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Authenticate & sign in the worker.
+        api_response = api_instance.sign_on(worker_sign_on)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->sign_on: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_sign_on** | [**WorkerSignOn**](WorkerSignOn.md)| Worker metadata |
+
+### Return type
+
+[**WorkerStateChange**](WorkerStateChange.md)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | normal response |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **task_output_produced**
+> task_output_produced(task_id, body)
+
+Store the most recently rendered frame here. Note that it is up to the Worker to ensure this is in a format that's digestable by the Manager. Currently only PNG and JPEG support is planned. 
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    task_id = "task_id_example" # str | 
+    body = open('/path/to/file', 'rb') # file_type | Contents of the file
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Store the most recently rendered frame here. Note that it is up to the Worker to ensure this is in a format that's digestable by the Manager. Currently only PNG and JPEG support is planned. 
+        api_instance.task_output_produced(task_id, body)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->task_output_produced: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **str**|  |
+ **body** | **file_type**| Contents of the file |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: image/jpeg, image/png
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**202** | The file was accepted for processing. |  -  |
+**411** | Length required; the client did not send a Content-Length header. |  -  |
+**413** | Payload too large. |  -  |
+**415** | Unsupported Media Type, the image format cannot be processed by the Manager. |  -  |
+**429** | The client is sending too many frames, and should throttle itself. |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **task_update**
+> task_update(task_id, task_update)
+
+Update the task, typically to indicate progress, completion, or failure.
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.task_update import TaskUpdate
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    task_id = "task_id_example" # str | 
+    task_update = TaskUpdate(
+        task_status=TaskStatus("active"),
+        activity="activity_example",
+        log="log_example",
+        steps_completed=1,
+    ) # TaskUpdate | Task update information
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Update the task, typically to indicate progress, completion, or failure.
+        api_instance.task_update(task_id, task_update)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->task_update: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **str**|  |
+ **task_update** | [**TaskUpdate**](TaskUpdate.md)| Task update information |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The update was accepted. |  -  |
+**409** | The task is assigned to another worker, so the update was not accepted. |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **worker_state**
+> WorkerStateChange worker_state()
+
+
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_state_change import WorkerStateChange
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        api_response = api_instance.worker_state()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->worker_state: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkerStateChange**](WorkerStateChange.md)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | no state change requested |  -  |
+**200** | state change requested |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
+# **worker_state_changed**
+> worker_state_changed(worker_state_changed)
+
+Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals.
+
+### Example
+
+* Basic Authentication (worker_auth):
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_state_changed import WorkerStateChanged
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: worker_auth
+configuration = flamenco.manager.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = worker_api.WorkerApi(api_client)
+    worker_state_changed = WorkerStateChanged(
+        status=WorkerStatus("starting"),
+    ) # WorkerStateChanged | New worker state
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals.
+        api_instance.worker_state_changed(worker_state_changed)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerApi->worker_state_changed: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_state_changed** | [**WorkerStateChanged**](WorkerStateChanged.md)| New worker state |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[worker_auth](../README.md#worker_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | normal response |  -  |
+**0** | unexpected error |  -  |
+
+[[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)
+
@@ -0,0 +1,13 @@
+# WorkerList
+
+List of workers.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workers** | [**[WorkerSummary]**](WorkerSummary.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,825 @@
+# flamenco.manager.WorkerMgtApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_worker_tag**](WorkerMgtApi.md#create_worker_tag) | **POST** /api/v3/worker-mgt/tags | Create a new worker tag.
+[**delete_worker**](WorkerMgtApi.md#delete_worker) | **DELETE** /api/v3/worker-mgt/workers/{worker_id} | Remove the given worker. It is recommended to only call this function when the worker is in &#x60;offline&#x60; state. If the worker is still running, stop it first. Any task still assigned to the worker will be requeued. 
+[**delete_worker_tag**](WorkerMgtApi.md#delete_worker_tag) | **DELETE** /api/v3/worker-mgt/tag/{tag_id} | Remove this worker tag. This unassigns all workers from the tag and removes it.
+[**fetch_worker**](WorkerMgtApi.md#fetch_worker) | **GET** /api/v3/worker-mgt/workers/{worker_id} | Fetch info about the worker.
+[**fetch_worker_sleep_schedule**](WorkerMgtApi.md#fetch_worker_sleep_schedule) | **GET** /api/v3/worker-mgt/workers/{worker_id}/sleep-schedule | 
+[**fetch_worker_tag**](WorkerMgtApi.md#fetch_worker_tag) | **GET** /api/v3/worker-mgt/tag/{tag_id} | Get a single worker tag.
+[**fetch_worker_tags**](WorkerMgtApi.md#fetch_worker_tags) | **GET** /api/v3/worker-mgt/tags | Get list of worker tags.
+[**fetch_workers**](WorkerMgtApi.md#fetch_workers) | **GET** /api/v3/worker-mgt/workers | Get list of workers.
+[**request_worker_status_change**](WorkerMgtApi.md#request_worker_status_change) | **POST** /api/v3/worker-mgt/workers/{worker_id}/setstatus | 
+[**set_worker_sleep_schedule**](WorkerMgtApi.md#set_worker_sleep_schedule) | **POST** /api/v3/worker-mgt/workers/{worker_id}/sleep-schedule | 
+[**set_worker_tags**](WorkerMgtApi.md#set_worker_tags) | **POST** /api/v3/worker-mgt/workers/{worker_id}/settags | 
+[**update_worker_tag**](WorkerMgtApi.md#update_worker_tag) | **PUT** /api/v3/worker-mgt/tag/{tag_id} | Update an existing worker tag.
+
+
+# **create_worker_tag**
+> WorkerTag create_worker_tag(worker_tag)
+
+Create a new worker tag.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_tag import WorkerTag
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_tag = WorkerTag(
+        id="id_example",
+        name="name_example",
+        description="description_example",
+    ) # WorkerTag | The worker tag.
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Create a new worker tag.
+        api_response = api_instance.create_worker_tag(worker_tag)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->create_worker_tag: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_tag** | [**WorkerTag**](WorkerTag.md)| The worker tag. |
+
+### Return type
+
+[**WorkerTag**](WorkerTag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | The tag was created. The created tag is returned, so that the caller can know its UUID. |  -  |
+**0** | Error message |  -  |
+
+[[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_worker**
+> delete_worker(worker_id)
+
+Remove the given worker. It is recommended to only call this function when the worker is in `offline` state. If the worker is still running, stop it first. Any task still assigned to the worker will be requeued. 
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Remove the given worker. It is recommended to only call this function when the worker is in `offline` state. If the worker is still running, stop it first. Any task still assigned to the worker will be requeued. 
+        api_instance.delete_worker(worker_id)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->delete_worker: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Normal response, worker has been deleted |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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_worker_tag**
+> delete_worker_tag(tag_id)
+
+Remove this worker tag. This unassigns all workers from the tag and removes it.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    tag_id = "tag_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Remove this worker tag. This unassigns all workers from the tag and removes it.
+        api_instance.delete_worker_tag(tag_id)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->delete_worker_tag: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_id** | **str**|  |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The tag has been removed. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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)
+
+# **fetch_worker**
+> Worker fetch_worker(worker_id)
+
+Fetch info about the worker.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.worker import Worker
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Fetch info about the worker.
+        api_response = api_instance.fetch_worker(worker_id)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->fetch_worker: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+
+### Return type
+
+[**Worker**](Worker.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Worker info |  -  |
+
+[[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)
+
+# **fetch_worker_sleep_schedule**
+> WorkerSleepSchedule fetch_worker_sleep_schedule(worker_id)
+
+
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_sleep_schedule import WorkerSleepSchedule
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        api_response = api_instance.fetch_worker_sleep_schedule(worker_id)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->fetch_worker_sleep_schedule: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+
+### Return type
+
+[**WorkerSleepSchedule**](WorkerSleepSchedule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Normal response, the sleep schedule. |  -  |
+**204** | The worker has no sleep schedule. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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)
+
+# **fetch_worker_tag**
+> WorkerTag fetch_worker_tag(tag_id)
+
+Get a single worker tag.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.worker_tag import WorkerTag
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    tag_id = "tag_id_example" # str | 
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Get a single worker tag.
+        api_response = api_instance.fetch_worker_tag(tag_id)
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->fetch_worker_tag: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_id** | **str**|  |
+
+### Return type
+
+[**WorkerTag**](WorkerTag.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | The worker tag. |  -  |
+
+[[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)
+
+# **fetch_worker_tags**
+> WorkerTagList fetch_worker_tags()
+
+Get list of worker tags.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.worker_tag_list import WorkerTagList
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Get list of worker tags.
+        api_response = api_instance.fetch_worker_tags()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->fetch_worker_tags: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkerTagList**](WorkerTagList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Worker tags. |  -  |
+
+[[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)
+
+# **fetch_workers**
+> WorkerList fetch_workers()
+
+Get list of workers.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.worker_list import WorkerList
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+
+    # example, this endpoint has no required or optional parameters
+    try:
+        # Get list of workers.
+        api_response = api_instance.fetch_workers()
+        pprint(api_response)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->fetch_workers: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WorkerList**](WorkerList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Known workers |  -  |
+
+[[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)
+
+# **request_worker_status_change**
+> request_worker_status_change(worker_id, worker_status_change_request)
+
+
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_status_change_request import WorkerStatusChangeRequest
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+    worker_status_change_request = WorkerStatusChangeRequest(
+        status=WorkerStatus("starting"),
+        is_lazy=True,
+    ) # WorkerStatusChangeRequest | The status change to request.
+
+    # example passing only required values which don't have defaults set
+    try:
+        api_instance.request_worker_status_change(worker_id, worker_status_change_request)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->request_worker_status_change: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+ **worker_status_change_request** | [**WorkerStatusChangeRequest**](WorkerStatusChangeRequest.md)| The status change to request. |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Status change was accepted. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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_worker_sleep_schedule**
+> set_worker_sleep_schedule(worker_id, worker_sleep_schedule)
+
+
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_sleep_schedule import WorkerSleepSchedule
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+    worker_sleep_schedule = WorkerSleepSchedule(
+        is_active=True,
+        days_of_week="days_of_week_example",
+        start_time="start_time_example",
+        end_time="end_time_example",
+    ) # WorkerSleepSchedule | The new sleep schedule.
+
+    # example passing only required values which don't have defaults set
+    try:
+        api_instance.set_worker_sleep_schedule(worker_id, worker_sleep_schedule)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->set_worker_sleep_schedule: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+ **worker_sleep_schedule** | [**WorkerSleepSchedule**](WorkerSleepSchedule.md)| The new sleep schedule. |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The schedule has been stored. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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_worker_tags**
+> set_worker_tags(worker_id, worker_tag_change_request)
+
+
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_tag_change_request import WorkerTagChangeRequest
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    worker_id = "worker_id_example" # str | 
+    worker_tag_change_request = WorkerTagChangeRequest(
+        tag_ids=[
+            "tag_ids_example",
+        ],
+    ) # WorkerTagChangeRequest | The list of worker tag IDs this worker should be a member of.
+
+    # example passing only required values which don't have defaults set
+    try:
+        api_instance.set_worker_tags(worker_id, worker_tag_change_request)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->set_worker_tags: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  |
+ **worker_tag_change_request** | [**WorkerTagChangeRequest**](WorkerTagChangeRequest.md)| The list of worker tag IDs this worker should be a member of. |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Status change was accepted. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[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)
+
+# **update_worker_tag**
+> update_worker_tag(tag_id, worker_tag)
+
+Update an existing worker tag.
+
+### Example
+
+
+```python
+import time
+import flamenco.manager
+from flamenco.manager.api import worker_mgt_api
+from flamenco.manager.model.error import Error
+from flamenco.manager.model.worker_tag import WorkerTag
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = flamenco.manager.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with flamenco.manager.ApiClient() as api_client:
+    # Create an instance of the API class
+    api_instance = worker_mgt_api.WorkerMgtApi(api_client)
+    tag_id = "tag_id_example" # str | 
+    worker_tag = WorkerTag(
+        id="id_example",
+        name="name_example",
+        description="description_example",
+    ) # WorkerTag | The updated worker tag.
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Update an existing worker tag.
+        api_instance.update_worker_tag(tag_id, worker_tag)
+    except flamenco.manager.ApiException as e:
+        print("Exception when calling WorkerMgtApi->update_worker_tag: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_id** | **str**|  |
+ **worker_tag** | [**WorkerTag**](WorkerTag.md)| The updated worker tag. |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | The tag update has been stored. |  -  |
+**0** | Error message |  -  |
+
+[[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)
+
@@ -0,0 +1,15 @@
+# WorkerRegistration
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**secret** | **str** |  | 
+**platform** | **str** |  | 
+**supported_task_types** | **[str]** |  | 
+**name** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# WorkerSignOn
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**supported_task_types** | **[str]** |  | 
+**software_version** | **str** |  | 
+**can_restart** | **bool** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,16 @@
+# WorkerSleepSchedule
+
+Sleep schedule for a single Worker. Start and end time indicate the time of each day at which the schedule is active. Applies only when today is in `days_of_week`, or when `days_of_week` is empty. Start and end time are in 24-hour HH:MM notation. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_active** | **bool** |  | 
+**days_of_week** | **str** | Space-separated two-letter strings indicating days of week the schedule is active (\&quot;mo\&quot;, \&quot;tu\&quot;, etc.). Empty means \&quot;every day\&quot;.  | 
+**start_time** | **str** |  | 
+**end_time** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# WorkerStateChange
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status_requested** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# WorkerStateChanged
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,11 @@
+# WorkerStatus
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** |  |  must be one of ["starting", "awake", "asleep", "error", "testing", "offline", "restart", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,14 @@
+# WorkerStatusChangeRequest
+
+Request for a Worker to change its status to `status`.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**is_lazy** | **bool** | Whether the status change should happen immediately, or after the worker&#39;s current task is finished.  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,19 @@
+# WorkerSummary
+
+Basic information about a Worker.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**name** | **str** |  | 
+**status** | [**WorkerStatus**](WorkerStatus.md) |  | 
+**version** | **str** | Version of Flamenco this Worker is running | 
+**can_restart** | **bool** | Whether this worker can auto-restart. | 
+**status_change** | [**WorkerStatusChangeRequest**](WorkerStatusChangeRequest.md) |  | [optional] 
+**last_seen** | **datetime** | Last time this worker was seen by the Manager. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,15 @@
+# WorkerTag
+
+Tag of workers. A job can optionally specify which tag it should be limited to. Workers can be part of multiple tags simultaneously. 
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**id** | **str** | UUID of the tag. Can be omitted when creating a new tag, in which case a random UUID will be assigned.  | [optional] 
+**description** | **str** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,13 @@
+# WorkerTagChangeRequest
+
+Request to change which tags this Worker is assigned to.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag_ids** | **[str]** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# WorkerTagList
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tags** | [**[WorkerTag]**](WorkerTag.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,23 @@
+# WorkerTask
+
+Task assigned to a Worker.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**name** | **str** |  | 
+**status** | [**TaskStatus**](TaskStatus.md) |  | 
+**index_in_job** | **int** |  | 
+**priority** | **int** |  | 
+**task_type** | **str** |  | 
+**updated** | **datetime** |  | 
+**steps_completed** | **int** |  | 
+**steps_total** | **int** |  | 
+**job_id** | **str** |  | 
+**worker** | [**TaskWorker**](TaskWorker.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
@@ -0,0 +1,12 @@
+# WorkerTaskAllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+