immich_api_rs 1.137.3

Immich API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# \TimelineApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_time_bucket**](TimelineApi.md#get_time_bucket) | **GET** /timeline/bucket | 
[**get_time_buckets**](TimelineApi.md#get_time_buckets) | **GET** /timeline/buckets | 



## get_time_bucket

> models::TimeBucketAssetResponseDto get_time_bucket(time_bucket, album_id, is_favorite, is_trashed, key, order, person_id, slug, tag_id, user_id, visibility, with_partners, with_stacked)


This endpoint requires the `asset.read` permission.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**time_bucket** | **String** | Time bucket identifier in YYYY-MM-DD format (e.g., \"2024-01-01\" for January 2024) | [required] |
**album_id** | Option<**uuid::Uuid**> | Filter assets belonging to a specific album |  |
**is_favorite** | Option<**bool**> | Filter by favorite status (true for favorites only, false for non-favorites only) |  |
**is_trashed** | Option<**bool**> | Filter by trash status (true for trashed assets only, false for non-trashed only) |  |
**key** | Option<**String**> |  |  |
**order** | Option<[**AssetOrder**](.md)> | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) |  |
**person_id** | Option<**uuid::Uuid**> | Filter assets containing a specific person (face recognition) |  |
**slug** | Option<**String**> |  |  |
**tag_id** | Option<**uuid::Uuid**> | Filter assets with a specific tag |  |
**user_id** | Option<**uuid::Uuid**> | Filter assets by specific user ID |  |
**visibility** | Option<[**AssetVisibility**](.md)> | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) |  |
**with_partners** | Option<**bool**> | Include assets shared by partners |  |
**with_stacked** | Option<**bool**> | Include stacked assets in the response. When true, only primary assets from stacks are returned. |  |

### Return type

[**models::TimeBucketAssetResponseDto**](TimeBucketAssetResponseDto.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

[[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_time_buckets

> Vec<models::TimeBucketsResponseDto> get_time_buckets(album_id, is_favorite, is_trashed, key, order, person_id, slug, tag_id, user_id, visibility, with_partners, with_stacked)


This endpoint requires the `asset.read` permission.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**album_id** | Option<**uuid::Uuid**> | Filter assets belonging to a specific album |  |
**is_favorite** | Option<**bool**> | Filter by favorite status (true for favorites only, false for non-favorites only) |  |
**is_trashed** | Option<**bool**> | Filter by trash status (true for trashed assets only, false for non-trashed only) |  |
**key** | Option<**String**> |  |  |
**order** | Option<[**AssetOrder**](.md)> | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) |  |
**person_id** | Option<**uuid::Uuid**> | Filter assets containing a specific person (face recognition) |  |
**slug** | Option<**String**> |  |  |
**tag_id** | Option<**uuid::Uuid**> | Filter assets with a specific tag |  |
**user_id** | Option<**uuid::Uuid**> | Filter assets by specific user ID |  |
**visibility** | Option<[**AssetVisibility**](.md)> | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) |  |
**with_partners** | Option<**bool**> | Include assets shared by partners |  |
**with_stacked** | Option<**bool**> | Include stacked assets in the response. When true, only primary assets from stacks are returned. |  |

### Return type

[**Vec<models::TimeBucketsResponseDto>**](TimeBucketsResponseDto.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

[[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)