GET STARTED WITH APIs
Overview
ENDPOINTS
Upload File
Digital Asset Management (DAM)
Custom metadata fields
Managing assets
Get file details
get
Update file details
patch
Delete file
delete
Delete multiple files
post
Copy file
post
Move file
post
Rename file
put
List file versions
get
Get file version details
get
Delete file version
delete
Restore file version
put
Add tags (bulk)
post
Remove tags (bulk)
post
Remove AI tags (bulk)
post
List and search assets
get
Managing folders
Caching
File Metadata
Account Management API
get
https://api.imagekit.io
/v1/files/{fileId}/details

This API returns an object with details or attributes about the current version of the file.

Request

fileId
string
required

The unique fileId of the uploaded file. fileId is returned in the list and search assets API and upload API.

Auth
API key
:
Parameters
:
Note

Here, you can explore machine-generated code examples. For practical applications, refer to the examples section below, which includes detailed code snippets from the ImageKit SDKs.

curl --request GET \
  --url https://api.imagekit.io/v1/files/fileId/details \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123'

Responses

File details object.

Body

fileId
string

Unique identifier of the asset.

type
string

Type of the asset.

Allowed values:
filefile-version
name
string

Name of the asset.

filePath
string

Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be /file.jpg. If the file is inside a folder named images, the path will be /images/file.jpg.

tags

An array of tags assigned to the file. Tags are used to search files in the media library.

AITags

An array of tags assigned to the file by auto tagging.

name
string

Name of the tag.

confidence
number

Confidence score of the tag.

source
string

Source of the tag. Possible values are google-auto-tagging and aws-auto-tagging.

versionInfo
object

An object with details of the file version.

id
string

Unique identifier of the file version.

name
string

Name of the file version.

isPrivateFile
boolean

Specifies if the file is private or not.

isPublished
boolean

Specifies if the file is published or not.

customCoordinates

An string with custom coordinates of the file.

url
string

URL of the file.

thumbnail
string

URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library.

fileType
string

Type of the file. Possible values are image, non-image.

mime
string

MIME type of the file.

width
number

Width of the file.

height
number

Height of the file.

size
number

Size of the file in bytes.

hasAlpha
boolean

Specifies if the image has an alpha channel.

customMetadata
object

An object with custom metadata for the file.

createdAt
string

Date and time when the file was uploaded. The date and time is in ISO8601 format.

updatedAt
string

Date and time when the file was last updated. The date and time is in ISO8601 format.

1
{
2
  "fileId": "598821f949c0a938d57563bd",
3
  "type": "file",
4
  "name": "file.jpg",
5
  "filePath": "/images/products/file.jpg",
6
  "tags": [
7
    "t-shirt",
8
    "round-neck",
9
    "sale2019"
10
  ],
11
  "AITags": [
12
    {
13
      "name": "Shirt",
14
      "confidence": 90.12,
15
      "source": "google-auto-tagging"
16
    },
17
    {
18
      "name": "T-shirt",
19
      "confidence": 80.12,
20
      "source": "aws-auto-tagging"
21
    }
22
  ],
23
  "versionInfo": {
24
    "id": "598821f949c0a938d57563bd",
25
    "name": "Version 1"
26
  },
27
  "isPrivateFile": false,
28
  "isPublished": true,
29
  "customCoordinates": null,
30
  "url": "https://ik.imagekit.io/your_imagekit_id/images/products/file.jpg?updatedAt=1566630881313",
31
  "thumbnail": "https://ik.imagekit.io/your_imagekit_id/images/products/file.jpg?updatedAt=1566630881313&tr=n-ik_ml_thumbnail",
32
  "fileType": "image",
33
  "mime": "image/jpeg",
34
  "width": 100,
35
  "height": 100,
36
  "size": 100,
37
  "hasAlpha": false,
38
  "customMetadata": {
39
    "brand": "Nike",
40
    "color": "red"
41
  },
42
  "createdAt": "2019-08-24T06:14:41.313Z",
43
  "updatedAt": "2019-08-24T06:14:41.313Z"
44
}

Examples

Here is the example request to understand the API usage.

Copy
# The unique fileId of the uploaded file. fileId is returned in response of list files API and upload API.
curl -X GET "https://api.imagekit.io/v1/files/file_id/details" \
-u your_private_api_key:

var ImageKit = require("imagekit");

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});

imagekit.getFileDetails("file_id", function(error, result) {
    if(error) console.log(error);
    else console.log(result);
});

from imagekitio import ImageKit

imagekit = ImageKit(
    public_key='your_public_api_key',
    private_key='your_private_api_key',
    url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)

details = imagekit.get_file_details(file_id="file_id")

print("File detail-", details, end="\n\n")

# Raw Response
print(details.response_metadata.raw)

# print that file's id
print(details.file_id)

use ImageKit\ImageKit;

$public_key = "your_public_api_key";
$your_private_key = "your_private_api_key";
$url_end_point = "https://ik.imagekit.io/your_imagekit_id";

$imageKit = new ImageKit(
    $public_key,
    $your_private_key,
    $url_end_point
);

$getFileDetails = $imageKit->getDetails("file_id");

echo("File details : " . json_encode($getFileDetails));

Result result=ImageKit.getInstance().getFileDetail("file_id");

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.get_file_deltails(file_id: 'file_id')

resp, err := ik.Media.FileById(ctx, "file_id")

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
Result res1 = imagekit.GetFileDetail("file_Id");