Files

Bas Dado 1e2e7dfb5a [TASK] Initial version, with some help from Junie. Copies all files in albums to the local filesystem.

2025-04-19 18:05:53 +02:00

28 KiB

Raw Blame History

generated.immich.openapi_client.PeopleApi

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

Method	HTTP request	Description
create_person	POST /people
get_all_people	GET /people
get_person	GET /people/{id}
get_person_statistics	GET /people/{id}/statistics
get_person_thumbnail	GET /people/{id}/thumbnail
merge_person	POST /people/{id}/merge
reassign_faces	PUT /people/{id}/reassign
update_people	PUT /people
update_person	PUT /people/{id}

create_person

PersonResponseDto create_person(person_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.person_create_dto import PersonCreateDto
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.PeopleApi(api_client)
    person_create_dto = generated.immich.openapi_client.PersonCreateDto() # PersonCreateDto | 

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

Parameters

Name	Type	Description	Notes
person_create_dto	PersonCreateDto

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
201		-

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

get_all_people

PeopleResponseDto get_all_people(closest_asset_id=closest_asset_id, closest_person_id=closest_person_id, page=page, size=size, with_hidden=with_hidden)

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.people_response_dto import PeopleResponseDto
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.PeopleApi(api_client)
    closest_asset_id = 'closest_asset_id_example' # str |  (optional)
    closest_person_id = 'closest_person_id_example' # str |  (optional)
    page = 1 # float | Page number for pagination (optional) (default to 1)
    size = 500 # float | Number of items per page (optional) (default to 500)
    with_hidden = True # bool |  (optional)

    try:
        api_response = api_instance.get_all_people(closest_asset_id=closest_asset_id, closest_person_id=closest_person_id, page=page, size=size, with_hidden=with_hidden)
        print("The response of PeopleApi->get_all_people:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PeopleApi->get_all_people: %s\n" % e)

Parameters

Name	Type	Description	Notes
closest_asset_id	str		[optional]
closest_person_id	str		[optional]
page	float	Page number for pagination	[optional] [default to 1]
size	float	Number of items per page	[optional] [default to 500]
with_hidden	bool		[optional]

Return type

PeopleResponseDto

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]

get_person

PersonResponseDto get_person(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.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.PeopleApi(api_client)
    id = 'id_example' # str | 

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

Parameters

Name	Type	Description	Notes
id	str

Return type

PersonResponseDto

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]

get_person_statistics

PersonStatisticsResponseDto get_person_statistics(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.person_statistics_response_dto import PersonStatisticsResponseDto
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.PeopleApi(api_client)
    id = 'id_example' # str | 

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

Parameters

Name	Type	Description	Notes
id	str

Return type

PersonStatisticsResponseDto

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]

get_person_thumbnail

bytearray get_person_thumbnail(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.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.PeopleApi(api_client)
    id = 'id_example' # str | 

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

Parameters

Name	Type	Description	Notes
id	str

Return type

bytearray

Authorization

cookie, api_key, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200		-

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

merge_person

List[BulkIdResponseDto] merge_person(id, merge_person_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.bulk_id_response_dto import BulkIdResponseDto
from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto
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.PeopleApi(api_client)
    id = 'id_example' # str | 
    merge_person_dto = generated.immich.openapi_client.MergePersonDto() # MergePersonDto | 

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

Parameters

Name	Type	Description	Notes
id	str
merge_person_dto	MergePersonDto

Return type

List[BulkIdResponseDto]

Authorization

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

reassign_faces

List[PersonResponseDto] reassign_faces(id, asset_face_update_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_update_dto import AssetFaceUpdateDto
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.PeopleApi(api_client)
    id = 'id_example' # str | 
    asset_face_update_dto = generated.immich.openapi_client.AssetFaceUpdateDto() # AssetFaceUpdateDto | 

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

Parameters

Name	Type	Description	Notes
id	str
asset_face_update_dto	AssetFaceUpdateDto

Return type

List[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]

update_people

List[BulkIdResponseDto] update_people(people_update_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.bulk_id_response_dto import BulkIdResponseDto
from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto
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.PeopleApi(api_client)
    people_update_dto = generated.immich.openapi_client.PeopleUpdateDto() # PeopleUpdateDto | 

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

Parameters

Name	Type	Description	Notes
people_update_dto	PeopleUpdateDto

Return type

List[BulkIdResponseDto]

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]

update_person

PersonResponseDto update_person(id, person_update_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.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.PeopleApi(api_client)
    id = 'id_example' # str | 
    person_update_dto = generated.immich.openapi_client.PersonUpdateDto() # PersonUpdateDto | 

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

Parameters

Name	Type	Description	Notes
id	str
person_update_dto	PersonUpdateDto

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]

28 KiB Raw Blame History

generated.immich.openapi_client.PeopleApi

create_person

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_people

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_person

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_person_statistics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_person_thumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

merge_person

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reassign_faces

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_people

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_person

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

28 KiB

Raw Blame History