Data Types


Gets the full details (e.g. metadata, tags, etc.) for a file.

GET /v2/accounts/{accountId}/files/details
1curl "{accountId}/files/details?filePath=/uploads/image.jpg" \
2 -H "Authorization: Bearer YOUR_API_KEY"
Response (200)
2 "accountId": "YOUR_ACCOUNT_ID",
3 "filePath": "/uploads/image.jpg",
4 "fileUrl": "",
5 "lastModified": 1615680311115,
6 "metadata": {
7 "myCustomField1": true,
8 "myCustomField2": {
9 "hello": "world"
10 },
11 "anotherCustomField": 42
12 },
13 "mime": "image/jpeg",
14 "originalFileName": "example.jpg",
15 "size": 43182,
16 "tags": [
17 "example_tag"
18 ]

Response Body

URL Parameters


Your account ID.

This is visible on the settings page:

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes


Absolute path to a file. Begins with a /.

Example: ?filePath=/uploads/image.jpg

Type: String

Min Length: 1

Max Length: 512

In: Querystring

Required: Yes

Request Headers


Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization, specifying apikey as your username, and your API key as your password.

Type: String

In: Header

Required: Yes

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: