File info — Uploadcare docs

Get file information by its UUID (immutable).

Path parameters

uuidstringRequired

File UUID.

Headers

AcceptstringOptional

Version header.

Query parameters

includestringOptional

Include additional fields to the file object, such as: appdata.

Response

This endpoint returns an object.

datetime_uploadeddatetime

Date and time when a file was uploaded.

is_imageboolean

Is file is image.

is_readyboolean

Is file is ready to be used after upload.

mime_typestring

File MIME-type.

original_filenamestring

Original file name taken from uploaded file.

sizeinteger

File size in bytes.

urlstring

API resource URL for a particular file.

uuidstring

File UUID.

datetime_removeddatetimeOptional

Date and time when a file was removed, if any.

datetime_storeddatetimeOptional

Date and time of the last store request, if any.

original_file_urlstringOptional

Publicly available file CDN URL. Available if a file is not deleted.

appdataobjectOptional

Dictionary of application names and data associated with these applications.

variationsmap from strings to anyOptional

Dictionary of other files that were created using this file as a source. It’s used for video processing and document conversion jobs. E.g., <conversion_path>: <uuid>.

content_infoobjectOptional

Information about file content.

metadatamap from strings to anyOptional

Arbitrary metadata associated with a file.

Errors

1 curl -G https://api.uploadcare.com/files/03ccf9ab-f266-43fb-973d-a6529c55c2ae/ \ 2 -H "Accept: application/vnd.uploadcare-v0.7+json" \ 3 -H "Authorization: <apiKey>" \ 4 -d include=appdata

1 { 2 "datetime_removed": "2024-01-15T09:30:00Z", 3 "datetime_stored": "2018-11-26T12:49:10Z", 4 "datetime_uploaded": "2018-11-26T12:49:09Z", 5 "is_image": true, 6 "is_ready": true, 7 "mime_type": "image/jpeg", 8 "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg", 9 "original_filename": "pineapple.jpg", 10 "size": 642, 11 "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/", 12 "uuid": "22240276-2f06-41f8-9411-755c8ce926ed", 13 "appdata": { 14 "aws_rekognition_detect_labels": { 15 "version": "2016-06-27", 16 "datetime_created": "2021-09-21T11:25:31Z", 17 "datetime_updated": "2021-09-21T11:27:33Z", 18 "data": { 19 "LabelModelVersion": "2.0", 20 "Labels": [ 21 { 22 "Confidence": 93.41645812988281, 23 "Instances": [ 24 {} 25 ], 26 "Name": "Home Decor", 27 "Parents": [ 28 {} 29 ] 30 }, 31 { 32 "Confidence": 70.75951385498047, 33 "Instances": [ 34 {} 35 ], 36 "Name": "Linen", 37 "Parents": [ 38 { 39 "Name": "Home Decor" 40 } 41 ] 42 }, 43 { 44 "Confidence": 64.7123794555664, 45 "Instances": [ 46 {} 47 ], 48 "Name": "Sunlight", 49 "Parents": [ 50 {} 51 ] 52 }, 53 { 54 "Confidence": 56.264793395996094, 55 "Instances": [ 56 {} 57 ], 58 "Name": "Flare", 59 "Parents": [ 60 { 61 "Name": "Light" 62 } 63 ] 64 }, 65 { 66 "Confidence": 50.47153854370117, 67 "Instances": [ 68 {} 69 ], 70 "Name": "Tree", 71 "Parents": [ 72 { 73 "Name": "Plant" 74 } 75 ] 76 } 77 ] 78 } 79 }, 80 "aws_rekognition_detect_moderation_labels": { 81 "version": "2016-06-27", 82 "datetime_created": "2023-02-21T11:25:31Z", 83 "datetime_updated": "2023-02-21T11:27:33Z", 84 "data": { 85 "ModerationModelVersion": "6.0", 86 "ModerationLabels": [ 87 { 88 "Confidence": 93.41645812988281, 89 "Name": "Weapons", 90 "ParentName": "Violence" 91 } 92 ] 93 } 94 }, 95 "remove_bg": { 96 "version": "1.0", 97 "datetime_created": "2021-07-25T12:24:33Z", 98 "datetime_updated": "2021-07-25T12:24:33Z", 99 "data": { 100 "foreground_type": "person" 101 } 102 }, 103 "uc_clamav_virus_scan": { 104 "version": "0.104.2", 105 "datetime_created": "2021-09-21T11:24:33Z", 106 "datetime_updated": "2021-09-21T11:24:33Z", 107 "data": { 108 "infected": true, 109 "infected_with": "Win.Test.EICAR_HDB-1" 110 } 111 } 112 }, 113 "variations": { 114 "key": "value" 115 }, 116 "content_info": { 117 "mime": { 118 "mime": "image/jpeg", 119 "type": "image", 120 "subtype": "jpeg" 121 }, 122 "image": { 123 "color_mode": "RGB", 124 "orientation": 6, 125 "format": "JPEG", 126 "sequence": false, 127 "height": 500, 128 "width": 500, 129 "geo_location": { 130 "latitude": 55.62013611111111, 131 "longitude": 37.66299166666666 132 }, 133 "datetime_original": "2018-08-20T08:59:50Z", 134 "dpi": [ 135 72, 136 72 137 ] 138 }, 139 "video": { 140 "duration": 261827, 141 "format": "mp4", 142 "bitrate": 393, 143 "audio": [ 144 { 145 "bitrate": 78, 146 "codec": "aac", 147 "sample_rate": 44100, 148 "channels": 2 149 } 150 ], 151 "video": [ 152 { 153 "height": 360, 154 "width": 640, 155 "frame_rate": 30, 156 "bitrate": 315, 157 "codec": "h264" 158 } 159 ] 160 } 161 }, 162 "metadata": { 163 "subsystem": "uploader", 164 "pet": "cat" 165 } 166 }

1	curl -G https://api.uploadcare.com/files/03ccf9ab-f266-43fb-973d-a6529c55c2ae/ \
2	-H "Accept: application/vnd.uploadcare-v0.7+json" \
3	-H "Authorization: <apiKey>" \
4	-d include=appdata

1	{
2	"datetime_removed": "2024-01-15T09:30:00Z",
3	"datetime_stored": "2018-11-26T12:49:10Z",
4	"datetime_uploaded": "2018-11-26T12:49:09Z",
5	"is_image": true,
6	"is_ready": true,
7	"mime_type": "image/jpeg",
8	"original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg",
9	"original_filename": "pineapple.jpg",
10	"size": 642,
11	"url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/",
12	"uuid": "22240276-2f06-41f8-9411-755c8ce926ed",
13	"appdata": {
14	"aws_rekognition_detect_labels": {
15	"version": "2016-06-27",
16	"datetime_created": "2021-09-21T11:25:31Z",
17	"datetime_updated": "2021-09-21T11:27:33Z",
18	"data": {
19	"LabelModelVersion": "2.0",
20	"Labels": [
21	{
22	"Confidence": 93.41645812988281,
23	"Instances": [
24	{}
25	],
26	"Name": "Home Decor",
27	"Parents": [
28	{}
29	]
30	},
31	{
32	"Confidence": 70.75951385498047,
33	"Instances": [
34	{}
35	],
36	"Name": "Linen",
37	"Parents": [
38	{
39	"Name": "Home Decor"
40	}
41	]
42	},
43	{
44	"Confidence": 64.7123794555664,
45	"Instances": [
46	{}
47	],
48	"Name": "Sunlight",
49	"Parents": [
50	{}
51	]
52	},
53	{
54	"Confidence": 56.264793395996094,
55	"Instances": [
56	{}
57	],
58	"Name": "Flare",
59	"Parents": [
60	{
61	"Name": "Light"
62	}
63	]
64	},
65	{
66	"Confidence": 50.47153854370117,
67	"Instances": [
68	{}
69	],
70	"Name": "Tree",
71	"Parents": [
72	{
73	"Name": "Plant"
74	}
75	]
76	}
77	]
78	}
79	},
80	"aws_rekognition_detect_moderation_labels": {
81	"version": "2016-06-27",
82	"datetime_created": "2023-02-21T11:25:31Z",
83	"datetime_updated": "2023-02-21T11:27:33Z",
84	"data": {
85	"ModerationModelVersion": "6.0",
86	"ModerationLabels": [
87	{
88	"Confidence": 93.41645812988281,
89	"Name": "Weapons",
90	"ParentName": "Violence"
91	}
92	]
93	}
94	},
95	"remove_bg": {
96	"version": "1.0",
97	"datetime_created": "2021-07-25T12:24:33Z",
98	"datetime_updated": "2021-07-25T12:24:33Z",
99	"data": {
100	"foreground_type": "person"
101	}
102	},
103	"uc_clamav_virus_scan": {
104	"version": "0.104.2",
105	"datetime_created": "2021-09-21T11:24:33Z",
106	"datetime_updated": "2021-09-21T11:24:33Z",
107	"data": {
108	"infected": true,
109	"infected_with": "Win.Test.EICAR_HDB-1"
110	}
111	}
112	},
113	"variations": {
114	"key": "value"
115	},
116	"content_info": {
117	"mime": {
118	"mime": "image/jpeg",
119	"type": "image",
120	"subtype": "jpeg"
121	},
122	"image": {
123	"color_mode": "RGB",
124	"orientation": 6,
125	"format": "JPEG",
126	"sequence": false,
127	"height": 500,
128	"width": 500,
129	"geo_location": {
130	"latitude": 55.62013611111111,
131	"longitude": 37.66299166666666
132	},
133	"datetime_original": "2018-08-20T08:59:50Z",
134	"dpi": [
135	72,
136	72
137	]
138	},
139	"video": {
140	"duration": 261827,
141	"format": "mp4",
142	"bitrate": 393,
143	"audio": [
144	{
145	"bitrate": 78,
146	"codec": "aac",
147	"sample_rate": 44100,
148	"channels": 2
149	}
150	],
151	"video": [
152	{
153	"height": 360,
154	"width": 640,
155	"frame_rate": 30,
156	"bitrate": 315,
157	"codec": "h264"
158	}
159	]
160	}
161	},
162	"metadata": {
163	"subsystem": "uploader",
164	"pet": "cat"
165	}
166	}