Skip to main content
GET
/
boxes
/
{boxId}
/
media
/
albums
/
{albumName}
/
media
JavaScript
import GboxSDK from "gbox-sdk";

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" });

  console.info("taking screenshot and saving to album...");
  await box.action.screenshot({
    saveToAlbum: true
  })

  const album = await box.media.getAlbum("Screenshots");

  console.info("listing media info...");

  const mediaInfo = await album.listMediaInfo();

  console.info(`media info: ${JSON.stringify(mediaInfo, null, 2)}`);

  const media = await album.listMedia();

  console.info("downloading media...");
  for (const item of media) {
    await item.download(`./${item.data.name}`);
  }

}

main();
{
  "data": [
    {
      "type": "photo",
      "mimeType": "image/jpeg",
      "name": "IMG_001.jpg",
      "path": "/sdcard/albums/vacation/IMG_001.jpg",
      "size": "2.5MB",
      "lastModified": "2021-01-01T00:00:00Z"
    }
  ]
}

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"

Response

200 - application/json

List of media files

List album media

data
(Photo · object | Video · object)[]
required

List of media files (photos and videos) in the album

  • Photo
  • Video