Get File

Retrieve a single gallery file by ID with localized metadata.

Method

GET /v1/gallery/files/:id

Path Parameters

id · uuid · required

Gallery file ID.

Query Parameters

locale · string

Preferred locale for alt/description (en, fr, etc.). Defaults to workspace default.

fallbackLocale · string

Locale used when the preferred locale has no translation.

includeMeta · string

Set to 1 to include translation maps and supported languages in metadata.

Headers

Authorization · string · required

Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

Request Example

cURL

curl "https://api.voyantcloud.com/v1/gallery/files/550e8400-e29b-41d4-a716-446655440000?locale=en&includeMeta=1" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "workspaceId": "ws_abc",
    "name": "ws_abc/banner_summer.png",
    "originalName": "banner_summer.png",
    "size": 245812,
    "mimeType": "image/png",
    "storageProvider": "cf-images",
    "folderId": "00000000-0000-0000-0000-000000000000",
    "status": "completed",
    "metadata": {
      "altText": "Summer sail banner",
      "description": "Hero artwork for the 2025 campaign",
      "locale": "en",
      "translations": {
        "en": {
          "altText": "Summer sail banner",
          "description": "Hero artwork for the 2025 campaign"
        },
        "fr": {
          "altText": "Banniere croisiere d'ete",
          "description": "Visuel principal pour la campagne 2025"
        }
      },
      "supportedLanguages": ["en", "fr", "de"]
    },
    "publicUrls": {
      "primary": "https://cdn.voyantcloud.com/gallery/ws_abc/banner_summer.png",
      "thumbnail": "https://cdn.voyantcloud.com/gallery/ws_abc/banner_summer_thumb.png"
    },
    "createdAt": "2025-02-10T08:15:00.000Z",
    "updatedAt": "2025-02-10T08:15:00.000Z"
  }
}

data.id · uuid

Unique file identifier.

data.workspaceId · uuid

Workspace the file belongs to.

data.name · string

Full storage path including workspace prefix.

data.originalName · string

Original filename as uploaded.

data.size · integer

File size in bytes.

data.mimeType · string

MIME type of the file.

data.storageProvider · string

cf-images, stream, or r2.

data.folderId · uuid | null

Folder ID, or null if in root.

data.status · string

Processing status: pending, processing, completed, failed.

data.metadata · object

File metadata including localized alt text and description.

data.publicUrls · object

CDN URLs for accessing the file.

To download the actual file bytes, use the Download File endpoint instead.