Dropbox: Get a thumbnail for an image — files get Thumbnail

Dropbox files.getThumbnail: arguments, response, policy and SDK examples.

Operation dropbox.files_get_thumbnail

Provider route: POST /2/files/get_thumbnail. Alter supplies the connection’s credentials and routing.

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, BackendError, ProviderAPIError } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["files"]["getThumbnail"]>[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.getThumbnail(input);
    const result = await call.wait();
    if (result.statusCode < 200 || result.statusCode >= 300)
      throw new ProviderAPIError("Provider download failed", result.statusCode);
    if (result.response.bodyTruncated)
      throw new BackendError("Provider download was truncated");
    return result.bodyBytes();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk.exceptions import BackendError, ProviderAPIError
from 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(arguments)
        result = await call.wait()
        if not 200 <= result.status_code < 300:
            raise ProviderAPIError("Provider download failed", result.status_code)
        if result.response.body_truncated:
            raise BackendError("Provider download was truncated")
        return result.body_bytes()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Required within parent	Additional keys: not allowed
`headers.Dropbox-API-Arg`	Model	Required within parent	Expand Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg
`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

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg

Response

Response media type: application/octet-stream. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	string	Root	Format: binary

Schemas

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 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 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

Policy, approvals and errors

SDK function policy ID: dropbox.files_get_thumbnail. Catalog operation: files/get_thumbnail. 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"]

Official provider source

Report an issue with this page