Get file details
GET {{api-server}}/:token/{{api-version}}/files/:file_uuid
This API endpoint is used to get file details.
Format parameters(?format=):
The following format parameters are used to format the API response.
| Key | Value | Default | Description | Example |
|---|---|---|---|---|
csv,json | - | json | Sets the response format to either csv or json | ?format=json |
select | api, human, internal, label | internal | Used to format metadata.Formats the select and multi-select field values in the response. internal - returns the internal key corresponding to the value human - returns values as human-readable labels api - returns the api_key of the value | ?format=select:human |
tags | json_full,json_compact | json_full | Tag display format. json_full will return tag values and internal keys json_compact will only return the internal key. | ?format=tags:json_compact |
labels | json_full,json_compact | json_compact | Labels display format.son_full will return label values and internal keys json_compact will only return the internal key. | ?format=labels:json_full |
Format Examples:
?format=json,select:internal
?format=csv,select:label,tags:json_compact
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
format | string | Format response.see format response section. | |
lang | string | Language variant to be returned.Please use correct language abbreviation. | |
csv_linebreak | string | in case format=csv is selected, defines the linebreak symbol |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Filerobot-Key | string | Filerobot API key | |
Content-Type | string |
RESPONSES
status: OK
{"status":"success","file":{"uuid":"341c6b77-ad4f-565d-8da7-fb7829850000","name":"flat.jpg","extension":"jpg","size":{"bytes":458988,"pretty":"448.23 KB"},"flags":null,"type":"image/jpeg","info":{"ext":"jpg","area":1151040,"img_h":880,"img_o":"LD","img_w":1308,"img_type":"JPEG","thumbnail":"https://fbmjmuoeb.filerobot.com/.internal/thumbnails/341c6b77-ad4f-565d-8da7-fb7829850000.jpg","visibility":1,"img_color_space":"RGB"},"meta":{"title":{"en":"nice flat"},"description":{"en":"the price is negotiable"},"id":null,"product-type":"@itm_v1_4905fe8f_1@","color_1":["@itm_v1_b3ac673b_3@"],"details":null,"year":null,"internal":null,"season":null,"approved":true},"tags":{"en":[{"sid":"#tg3885e","label":"360"},{"sid":"#tg81221","label":"Clothes hanger"},{"sid":"#tga63d4","label":"Car"}],"fr":[{"sid":"#tg3885e","label":"~ 360"},{"sid":"#tg81221","label":"Cintre"},{"sid":"#tga63d4","label":"Voiture"}]},"labels":["#lb9kzmglo"],"relevance":null,"visibility":{"in_dam":{"set":"inherited","actual":"all_organisation"},"in_cdn":{"set":"inherited","actual":"inherited"}},"is_favorite":null,"url":{"public":"https://store.filerobot.com/fbmjmuoeb/Docs/flat.jpg","permalink":"https://api.filerobot.com/fbmjmuoeb/v5/get/341c6b77-ad4f-565d-8da7-fb7829850000","cdn":"https://fbmjmuoeb.filerobot.com/Docs/flat.jpg?vh=1e845d","path":"/Docs/flat.jpg"},"hash":{"sha1":"1e845d7ce4e32afd080b4efee20226d3dc65eb86","blurhash":null},"iptc_xml":{},"created_at":"2023-07-17T08:33:44Z","modified_at":"2023-08-08T08:23:10Z","folder":{"uuid":"20f67ac0-ea7a-5ae9-a844-42cf9b7ae4e4","name":"/Docs"},"product":{"ref":"Name-change-ref","position":"1"}},"api_version":{"hash":"fb3440b980d63376bfcd277b9811349cd7f6280a","datetime":"2023-08-07T23:26:19+07:00"}}