---
title: "Read file metadata"
method: GET
path: "/v1/workspaces/{workspace}/files/{key}"
---

# Read file metadata

`GET /v1/workspaces/{workspace}/files/{key}`

## Request

- Base URL: `https://api.uploads.sh`
- URL: `https://api.uploads.sh/v1/workspaces/{workspace}/files/{key}`
- Auth: HTTP bearer

## Query parameters

- `metadata` boolean

## Response `200`

Object metadata, or a metadata-only response when requested.

- union
  - FileHead
    - `key` string, required
    - `size` integer, required
    - `contentType` string, required
    - `uploaded` string, date-time
    - `url` string, uri, nullable, required
    - `embedUrl` string, uri, nullable, required
    - `metadata` Metadata
    - `visibility` 'public' | 'private'
  - MetadataResult
    - `metadata` Metadata, required

## Other responses

- `401`: Missing or invalid credential.
- `403`: The credential lacks the required scope or role.
- `404`: The resource was not found.

---

[API](https://skmtc.dev/uploads/apis/uploads-sh-api.md) · [All operations](https://skmtc.dev/uploads/apis/uploads-sh-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uploads/apis/uploads-sh-api/revisions/6df242babacd?raw)