GET
/
boxes
/
{boxId}
/
media
/
albums
/
{albumName}
/
media
/
{mediaName}
/
download
JavaScript
import GboxSDK from "gbox-sdk";
import fs from "fs";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "android" });

  // Download a specific media file from an album
  const album = await box.media.getAlbum("vacation-2024");

	// Download all media files in the album to the specified local directory
	await album.download("/path/to/dir")

	const media = await album.listMedia();

	await media[0].download("/path/to/my-photo.jpg")

}

main();
This response does not have an example.

Authorizations

Authorization
string
header
required

Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai

Path Parameters

boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

albumName
string
required

Album name

Example:

"Pictures"

mediaName
string
required

Media name

Example:

"IMG_001.jpg"

Response

200 - application/octet-stream

Media file content

The response is of type file.