# generated.immich.openapi_client.ActivitiesApi All URIs are relative to *https://github.com/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_activity**](ActivitiesApi.md#create_activity) | **POST** /activities | [**delete_activity**](ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} | [**get_activities**](ActivitiesApi.md#get_activities) | **GET** /activities | [**get_activity_statistics**](ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics | # **create_activity** > ActivityResponseDto create_activity(activity_create_dto) ### 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.activity_create_dto import ActivityCreateDto from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto 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.ActivitiesApi(api_client) activity_create_dto = generated.immich.openapi_client.ActivityCreateDto() # ActivityCreateDto | try: api_response = api_instance.create_activity(activity_create_dto) print("The response of ActivitiesApi->create_activity:\n") pprint(api_response) except Exception as e: print("Exception when calling ActivitiesApi->create_activity: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **activity_create_dto** | [**ActivityCreateDto**](ActivityCreateDto.md)| | ### Return type [**ActivityResponseDto**](ActivityResponseDto.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 | |-------------|-------------|------------------| **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) # **delete_activity** > delete_activity(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.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.ActivitiesApi(api_client) id = 'id_example' # str | try: api_instance.delete_activity(id) except Exception as e: print("Exception when calling ActivitiesApi->delete_activity: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | ### 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**: Not defined - **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) # **get_activities** > List[ActivityResponseDto] get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_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.activity_response_dto import ActivityResponseDto from generated.immich.openapi_client.models.reaction_level import ReactionLevel from generated.immich.openapi_client.models.reaction_type import ReactionType 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.ActivitiesApi(api_client) album_id = 'album_id_example' # str | asset_id = 'asset_id_example' # str | (optional) level = generated.immich.openapi_client.ReactionLevel() # ReactionLevel | (optional) type = generated.immich.openapi_client.ReactionType() # ReactionType | (optional) user_id = 'user_id_example' # str | (optional) try: api_response = api_instance.get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_id) print("The response of ActivitiesApi->get_activities:\n") pprint(api_response) except Exception as e: print("Exception when calling ActivitiesApi->get_activities: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **album_id** | **str**| | **asset_id** | **str**| | [optional] **level** | [**ReactionLevel**](.md)| | [optional] **type** | [**ReactionType**](.md)| | [optional] **user_id** | **str**| | [optional] ### Return type [**List[ActivityResponseDto]**](ActivityResponseDto.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) # **get_activity_statistics** > ActivityStatisticsResponseDto get_activity_statistics(album_id, asset_id=asset_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.activity_statistics_response_dto import ActivityStatisticsResponseDto 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.ActivitiesApi(api_client) album_id = 'album_id_example' # str | asset_id = 'asset_id_example' # str | (optional) try: api_response = api_instance.get_activity_statistics(album_id, asset_id=asset_id) print("The response of ActivitiesApi->get_activity_statistics:\n") pprint(api_response) except Exception as e: print("Exception when calling ActivitiesApi->get_activity_statistics: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **album_id** | **str**| | **asset_id** | **str**| | [optional] ### Return type [**ActivityStatisticsResponseDto**](ActivityStatisticsResponseDto.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)