# generated.immich.openapi_client.DeprecatedApi All URIs are relative to *https://github.com/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_partner_deprecated**](DeprecatedApi.md#create_partner_deprecated) | **POST** /partners/{id} | Create a partner [**get_queues_legacy**](DeprecatedApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status [**run_queue_command_legacy**](DeprecatedApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs [**update_api_key**](DeprecatedApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key [**update_asset**](DeprecatedApi.md#update_asset) | **PUT** /assets/{id} | Update an asset [**update_assets**](DeprecatedApi.md#update_assets) | **PUT** /assets | Update assets [**update_library**](DeprecatedApi.md#update_library) | **PUT** /libraries/{id} | Update a library [**update_memory**](DeprecatedApi.md#update_memory) | **PUT** /memories/{id} | Update a memory [**update_my_preferences**](DeprecatedApi.md#update_my_preferences) | **PUT** /users/me/preferences | Update my preferences [**update_my_user**](DeprecatedApi.md#update_my_user) | **PUT** /users/me | Update current user [**update_person**](DeprecatedApi.md#update_person) | **PUT** /people/{id} | Update person [**update_session**](DeprecatedApi.md#update_session) | **PUT** /sessions/{id} | Update a session [**update_stack**](DeprecatedApi.md#update_stack) | **PUT** /stacks/{id} | Update a stack [**update_tag**](DeprecatedApi.md#update_tag) | **PUT** /tags/{id} | Update a tag [**update_user_admin**](DeprecatedApi.md#update_user_admin) | **PUT** /admin/users/{id} | Update a user [**update_user_preferences_admin**](DeprecatedApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences | Update user preferences [**update_workflow**](DeprecatedApi.md#update_workflow) | **PUT** /workflows/{id} | Update a workflow # **create_partner_deprecated** > PartnerResponseDto create_partner_deprecated(id) Create a partner Create a new partner to share assets with. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | try: # Create a partner api_response = api_instance.create_partner_deprecated(id) print("The response of DeprecatedApi->create_partner_deprecated:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->create_partner_deprecated: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | ### Return type [**PartnerResponseDto**](PartnerResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | | - | [[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_queues_legacy** > QueuesResponseLegacyDto get_queues_legacy() Retrieve queue counts and status Retrieve the counts of the current queue, as well as the current status. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) try: # Retrieve queue counts and status api_response = api_instance.get_queues_legacy() print("The response of DeprecatedApi->get_queues_legacy:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->get_queues_legacy: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **run_queue_command_legacy** > QueueResponseLegacyDto run_queue_command_legacy(name, queue_command_dto) Run jobs Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto from generated.immich.openapi_client.models.queue_name import QueueName from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) name = generated.immich.openapi_client.QueueName() # QueueName | queue_command_dto = generated.immich.openapi_client.QueueCommandDto() # QueueCommandDto | try: # Run jobs api_response = api_instance.run_queue_command_legacy(name, queue_command_dto) print("The response of DeprecatedApi->run_queue_command_legacy:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->run_queue_command_legacy: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | [**QueueName**](.md)| | **queue_command_dto** | [**QueueCommandDto**](QueueCommandDto.md)| | ### Return type [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_api_key** > ApiKeyResponseDto update_api_key(id, api_key_update_dto) Update an API key Updates the name and permissions of an API key by its ID. The current user must own this API key. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | api_key_update_dto = generated.immich.openapi_client.ApiKeyUpdateDto() # ApiKeyUpdateDto | try: # Update an API key api_response = api_instance.update_api_key(id, api_key_update_dto) print("The response of DeprecatedApi->update_api_key:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_api_key: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **api_key_update_dto** | [**ApiKeyUpdateDto**](ApiKeyUpdateDto.md)| | ### Return type [**ApiKeyResponseDto**](ApiKeyResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_asset** > AssetResponseDto update_asset(id, update_asset_dto) Update an asset Update information of a specific asset. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | update_asset_dto = generated.immich.openapi_client.UpdateAssetDto() # UpdateAssetDto | try: # Update an asset api_response = api_instance.update_asset(id, update_asset_dto) print("The response of DeprecatedApi->update_asset:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_asset: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **update_asset_dto** | [**UpdateAssetDto**](UpdateAssetDto.md)| | ### Return type [**AssetResponseDto**](AssetResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_assets** > update_assets(asset_bulk_update_dto) Update assets Updates multiple assets at the same time. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) asset_bulk_update_dto = generated.immich.openapi_client.AssetBulkUpdateDto() # AssetBulkUpdateDto | try: # Update assets api_instance.update_assets(asset_bulk_update_dto) except Exception as e: print("Exception when calling DeprecatedApi->update_assets: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **asset_bulk_update_dto** | [**AssetBulkUpdateDto**](AssetBulkUpdateDto.md)| | ### Return type void (empty response body) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | | - | [[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_library** > LibraryResponseDto update_library(id, update_library_dto) Update a library Update an existing external library. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | update_library_dto = generated.immich.openapi_client.UpdateLibraryDto() # UpdateLibraryDto | try: # Update a library api_response = api_instance.update_library(id, update_library_dto) print("The response of DeprecatedApi->update_library:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_library: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **update_library_dto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| | ### Return type [**LibraryResponseDto**](LibraryResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_memory** > MemoryResponseDto update_memory(id, memory_update_dto) Update a memory Update an existing memory by its ID. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | memory_update_dto = generated.immich.openapi_client.MemoryUpdateDto() # MemoryUpdateDto | try: # Update a memory api_response = api_instance.update_memory(id, memory_update_dto) print("The response of DeprecatedApi->update_memory:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_memory: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **memory_update_dto** | [**MemoryUpdateDto**](MemoryUpdateDto.md)| | ### Return type [**MemoryResponseDto**](MemoryResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_my_preferences** > UserPreferencesResponseDto update_my_preferences(user_preferences_update_dto) Update my preferences Update the preferences of the current user. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | try: # Update my preferences api_response = api_instance.update_my_preferences(user_preferences_update_dto) print("The response of DeprecatedApi->update_my_preferences:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_my_preferences: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | ### Return type [**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_my_user** > UserAdminResponseDto update_my_user(user_update_me_dto) Update current user Update the current user making the API request. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) user_update_me_dto = generated.immich.openapi_client.UserUpdateMeDto() # UserUpdateMeDto | try: # Update current user api_response = api_instance.update_my_user(user_update_me_dto) print("The response of DeprecatedApi->update_my_user:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_my_user: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_update_me_dto** | [**UserUpdateMeDto**](UserUpdateMeDto.md)| | ### Return type [**UserAdminResponseDto**](UserAdminResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_person** > PersonResponseDto update_person(id, person_update_dto) Update person Update an individual person. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | person_update_dto = generated.immich.openapi_client.PersonUpdateDto() # PersonUpdateDto | try: # Update person api_response = api_instance.update_person(id, person_update_dto) print("The response of DeprecatedApi->update_person:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_person: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **person_update_dto** | [**PersonUpdateDto**](PersonUpdateDto.md)| | ### Return type [**PersonResponseDto**](PersonResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_session** > SessionResponseDto update_session(id, session_update_dto) Update a session Update a specific session identified by id. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | session_update_dto = generated.immich.openapi_client.SessionUpdateDto() # SessionUpdateDto | try: # Update a session api_response = api_instance.update_session(id, session_update_dto) print("The response of DeprecatedApi->update_session:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_session: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **session_update_dto** | [**SessionUpdateDto**](SessionUpdateDto.md)| | ### Return type [**SessionResponseDto**](SessionResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_stack** > StackResponseDto update_stack(id, stack_update_dto) Update a stack Update an existing stack by its ID. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | stack_update_dto = generated.immich.openapi_client.StackUpdateDto() # StackUpdateDto | try: # Update a stack api_response = api_instance.update_stack(id, stack_update_dto) print("The response of DeprecatedApi->update_stack:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_stack: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **stack_update_dto** | [**StackUpdateDto**](StackUpdateDto.md)| | ### Return type [**StackResponseDto**](StackResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_tag** > TagResponseDto update_tag(id, tag_update_dto) Update a tag Update an existing tag identified by its ID. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | tag_update_dto = generated.immich.openapi_client.TagUpdateDto() # TagUpdateDto | try: # Update a tag api_response = api_instance.update_tag(id, tag_update_dto) print("The response of DeprecatedApi->update_tag:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_tag: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **tag_update_dto** | [**TagUpdateDto**](TagUpdateDto.md)| | ### Return type [**TagResponseDto**](TagResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_user_admin** > UserAdminResponseDto update_user_admin(id, user_admin_update_dto) Update a user Update an existing user. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | user_admin_update_dto = generated.immich.openapi_client.UserAdminUpdateDto() # UserAdminUpdateDto | try: # Update a user api_response = api_instance.update_user_admin(id, user_admin_update_dto) print("The response of DeprecatedApi->update_user_admin:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_user_admin: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **user_admin_update_dto** | [**UserAdminUpdateDto**](UserAdminUpdateDto.md)| | ### Return type [**UserAdminResponseDto**](UserAdminResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_user_preferences_admin** > UserPreferencesResponseDto update_user_preferences_admin(id, user_preferences_update_dto) Update user preferences Update the preferences of a specific user. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | try: # Update user preferences api_response = api_instance.update_user_preferences_admin(id, user_preferences_update_dto) print("The response of DeprecatedApi->update_user_preferences_admin:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_user_preferences_admin: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | ### Return type [**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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_workflow** > WorkflowResponseDto update_workflow(id, workflow_update_dto) Update a workflow Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.workflow_response_dto import WorkflowResponseDto from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # 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 API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.DeprecatedApi(api_client) id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | workflow_update_dto = generated.immich.openapi_client.WorkflowUpdateDto() # WorkflowUpdateDto | try: # Update a workflow api_response = api_instance.update_workflow(id, workflow_update_dto) print("The response of DeprecatedApi->update_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling DeprecatedApi->update_workflow: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **UUID**| | **workflow_update_dto** | [**WorkflowUpdateDto**](WorkflowUpdateDto.md)| | ### Return type [**WorkflowResponseDto**](WorkflowResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[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)