immich-to-cloud-exporter/generated/immich/openapi_client/docs/FacesApi.md

generated.immich.openapi_client.FacesApi

All URIs are relative to https://github.com/api

Method	HTTP request	Description
create_face	POST /faces
delete_face	DELETE /faces/{id}
get_faces	GET /faces
reassign_faces_by_id	PUT /faces/{id}

create_face

create_face(asset_face_create_dto)

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto
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.FacesApi(api_client)
    asset_face_create_dto = generated.immich.openapi_client.AssetFaceCreateDto() # AssetFaceCreateDto | 

    try:
        api_instance.create_face(asset_face_create_dto)
    except Exception as e:
        print("Exception when calling FacesApi->create_face: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_face_create_dto	AssetFaceCreateDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_face

delete_face(id, asset_face_delete_dto)

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto
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.FacesApi(api_client)
    id = 'id_example' # str | 
    asset_face_delete_dto = generated.immich.openapi_client.AssetFaceDeleteDto() # AssetFaceDeleteDto | 

    try:
        api_instance.delete_face(id, asset_face_delete_dto)
    except Exception as e:
        print("Exception when calling FacesApi->delete_face: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
asset_face_delete_dto	AssetFaceDeleteDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_faces

List[AssetFaceResponseDto] get_faces(id)

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto
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.FacesApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.get_faces(id)
        print("The response of FacesApi->get_faces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FacesApi->get_faces: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

List[AssetFaceResponseDto]

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

reassign_faces_by_id

PersonResponseDto reassign_faces_by_id(id, face_dto)

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.face_dto import FaceDto
from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto
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.FacesApi(api_client)
    id = 'id_example' # str | 
    face_dto = generated.immich.openapi_client.FaceDto() # FaceDto | 

    try:
        api_response = api_instance.reassign_faces_by_id(id, face_dto)
        print("The response of FacesApi->reassign_faces_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FacesApi->reassign_faces_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
face_dto	FaceDto

Return type

PersonResponseDto

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]