Dropbox: Asynchronous file transformation: produces a new file from an existing one

← Riviera operations · Get started

Operation dropbox.riviera_get_transform_async

Provider route: POST /2/riviera/get_transform_async. 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 } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["riviera"]["getTransformAsync"]>[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.riviera.getTransformAsync(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
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.riviera.get_transform_async(arguments)
        result = await call.wait()
        return result.body_json()

Input

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 Asynchronous file transformation: produces a new file from an existing one — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Asynchronous file transformation: produces a new file from an existing one — request body — body

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 Launch a member suspension batch — response body

Referenced models: Launch a member suspension batch — response body

Schemas

3 more schemas are linked from the tables above, on the schema pages.

Launch a member suspension batch — response body

Field	Type	Presence	Description and constraints
$	JSON	Root	Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: async_job_id
$ (anyOf 1).async_job_id	string	Required within parent	Minimum length: 1

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

Asynchronous file transformation: produces a new file from an existing one — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Arguments for the asynchronous `get_transform_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the source file, and exactly one variant of `transform_type` must be set to say what to produce from it. At most one options message may be set, and it must be the one belonging to the requested `transform_type`. Options that belong to a different transform type are rejected with `invalid_options_error` rather than ignored, so that a request whose parameters were misassembled fails visibly instead of quietly producing the wrong output.
file_id_or_url	JSON	Optional
file_id_or_url (anyOf 1)	Model	Alternative	Expand Asynchronous plain-text extraction from documents — request body — body file id or url value
file_id_or_url (anyOf 2)	null	Alternative
transform_type	Model	Required within parent	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body transform type
thumbnail	JSON	Optional
thumbnail (anyOf 1)	Model	Alternative	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size
thumbnail (anyOf 2)	null	Alternative
image	JSON	Optional
image (anyOf 1)	Model	Alternative	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body image page number, scale percent
image (anyOf 2)	null	Alternative
video_frame	JSON	Optional
video_frame (anyOf 1)	Model	Alternative	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body video frame offset in seconds, scale percent
video_frame (anyOf 2)	null	Alternative

Referenced models: Asynchronous plain-text extraction from documents — request body — body file id or url value, Asynchronous file transformation: produces a new file from an existing one — request body — body image page number, scale percent, Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size, Asynchronous file transformation: produces a new file from an existing one — request body — body transform type, Asynchronous file transformation: produces a new file from an existing one — request body — body video frame offset in seconds, scale percent

Asynchronous plain-text extraction from documents — request body — body file id or url value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: file_id
$ (anyOf 1).file_id	string	Required within parent
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: url
$ (anyOf 2).url	string	Required within parent
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: path
$ (anyOf 3).path	string	Required within parent
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:file_id|url|path)$)

Asynchronous file transformation: produces a new file from an existing one — request body — body image page number, scale percent

Field	Type	Presence	Description and constraints
$	object	Root	Options for `TransformType.image` and `TransformType.image_pdf`. Supplying this message with any other transform type fails with `invalid_options_error`.
page_number	integer	Optional	Minimum: 1
scale_percent	integer	Optional	Minimum: 1 Maximum: 100

Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size

Field	Type	Presence	Description and constraints
$	object	Root	Options for `TransformType.thumbnail`. Supplying this message with any other transform type fails with `invalid_options_error`.
size	Model	Optional	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size size
mode	Model	Optional	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size mode
format	Model	Optional	Expand Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size format

Referenced models: Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size format, Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size mode, Asynchronous file transformation: produces a new file from an existing one — request body — body thumbnail format, mode, size size

Asynchronous file transformation: produces a new file from an existing one — request body — body transform type

Field	Type	Presence	Description and constraints
$	JSON	Root	Which derived file to produce from the source file. Unlike the other Riviera content routes, which each expose one capability, `get_transform_async` is a single route over many conversions: the caller names the source file and the output it wants, and the service picks the conversion pipeline. Exactly one variant must be set; a request with none set fails with `invalid_options_error`.
$ (anyOf 1)	string	Alternative	One of: pdf, html, image, thumbnail, image_pdf, video_frame
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: pdf
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: html
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: image
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: thumbnail
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: image_pdf
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: video_frame
$ (anyOf 8)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tag	string	Required within parent	Pattern: ^(?!(?:pdf|html|image|thumbnail|image_pdf|video_frame)$)

Asynchronous file transformation: produces a new file from an existing one — request body — body video frame offset in seconds, scale percent

Field	Type	Presence	Description and constraints
$	object	Root	Options for `TransformType.video_frame`. Supplying this message with any other transform type fails with `invalid_options_error`.
offset_in_seconds	number	Optional	Minimum: 0
scale_percent	integer	Optional	Minimum: 1 Maximum: 100

Policy, approvals and errors

SDK function policy ID: dropbox.riviera_get_transform_async. Catalog operation: riviera/get_transform_async. 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