Dropbox: Get thumbnails for a list of images
Dropbox files.getThumbnailBatch: arguments, response, policy and SDK examples.
← Files operations · Get started
Operation dropbox.files_get_thumbnail_batch
Provider route: POST /2/files/get_thumbnail_batch. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DropboxIntegration } from "@alter-ai/dropbox";
async function execute(input: Parameters<DropboxIntegration["files"]["getThumbnailBatch"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.files.getThumbnailBatch(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_dropbox import DropboxIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.files.get_thumbnail_batch(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Dropbox-API-Path-Root | Model | Optional | Expand Deletes a group — request body — headers Dropbox-API-Path-Root |
headers.Dropbox-API-Select-User | string | Optional | |
headers.Dropbox-API-Select-Admin | string | Optional | |
body | Model | Required within parent | Expand Get thumbnails for a list of images — request body — body |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Get thumbnails for a list of images — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get thumbnails for a list of images — response body |
Referenced models: Get thumbnails for a list of images — response body
Schemas
Section titled “Schemas”12 more schemas are linked from the tables above, on the schema pages.
Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Get thumbnails for a list of images — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Arguments for get_thumbnail_batch. |
entries | array | Required within parent | |
entries[] | Model | Each item | Expand Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg |
Referenced models: Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg
Get thumbnails for a list of images — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entries | array | Required within parent | |
entries[] | Model | Each item | Expand Get thumbnails for a list of images — response body — entries item |
Referenced models: Get thumbnails for a list of images — response body — entries item
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
format | Model | Optional | Expand Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format |
size | Model | Optional | Expand Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size |
mode | Model | Optional | Expand Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode |
exclude_media_info | JSON | Optional | |
exclude_media_info (anyOf 1) | boolean | Alternative | |
exclude_media_info (anyOf 2) | null | Alternative |
Referenced models: Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size
Get thumbnails for a list of images — response body — entries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: success |
$ (anyOf 1).metadata | Model | Required within parent | Expand Restore a specific revision of a file to the given path — response body |
$ (anyOf 1).thumbnail | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: failure |
$ (anyOf 2).failure | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:success|failure)$) |
Referenced models: Restore a specific revision of a file to the given path — response body, Get thumbnails for a list of images — response body — entries item tag failure failure
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: jpeg, png, webp |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: jpeg |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: png |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: webp |
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: strict, bestfit, fitone_bestfit, original |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: strict |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: bestfit |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: fitone_bestfit |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: original |
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: w32h32, w64h64, w128h128, w256h256, w480h320, w640h480, w960h640, w1024h768, w2048h1536 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: w32h32 |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: w64h64 |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: w128h128 |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: w256h256 |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: w480h320 |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: w640h480 |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: w960h640 |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: w1024h768 |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: w2048h1536 |
Get thumbnails for a list of images — response body — entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: unsupported_extension, unsupported_image, encrypted_content, conversion_error |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path |
$ (anyOf 2).path | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: unsupported_extension |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: unsupported_image |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: encrypted_content |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: conversion_error |
Referenced models: Get thumbnails for a list of images — response body — entries item tag failure failure tag path path
Restore a specific revision of a file to the given path — response body — symlink info target
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
target | string | Required within parent |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.files_get_thumbnail_batch. Catalog operation: files/get_thumbnail_batch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["files.content.read"]