GetFileDetails

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

1curl "https://api.bytescale.com/v2/accounts/{accountId}/files/details?filePath=/uploads/image.jpg" \
2     -H "Authorization: Bearer YOUR_API_KEY"

1{
2  "accountId": "YOUR_ACCOUNT_ID",
3  "filePath": "/uploads/image.jpg",
4  "fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
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  ]
19}

Response Body

See full details

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes

filePath

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

Authorization

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:

Chrome

Download

Firefox

Download

Opera

Download

Safari

Download
(macOS only)

Internet Explorer

Download
(Windows only)

Microsoft Edge

Download
(Windows only)