Skip to content

Dropbox: Asynchronous content extraction from a single file

Dropbox riviera.extractAsync: arguments, response, policy and SDK examples.

← Riviera operations · Get started

Operation dropbox.riviera_extract_async

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

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"]["extractAsync"]>[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.extractAsync(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.extract_async(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Dropbox-API-Path-RootModelOptionalExpand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-UserstringOptional
headers.Dropbox-API-Select-AdminstringOptional
bodyModelRequired within parentExpand Asynchronous content extraction from a single file — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Asynchronous content extraction from a single file — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Launch a member suspension batch — response body

Referenced models: Launch a member suspension batch — response body

Launch a member suspension batch — response body
FieldTypePresenceDescription and constraints
$JSONRootResult 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)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: async_job_id
$ (anyOf 1).async_job_idstringRequired within parentMinimum length: 1
Deletes a group — request body — headers Dropbox-API-Path-Root
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: home
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: home
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: root
$ (anyOf 3).rootstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: namespace_id
$ (anyOf 4).namespace_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:home|root|namespace_id)$)
Asynchronous content extraction from a single file — request body — body
FieldTypePresenceDescription and constraints
$objectRootArguments for the asynchronous `extract_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the source file, and `extract_type` must say what to extract from it.
file_id_or_urlJSONOptional
file_id_or_url (anyOf 1)ModelAlternativeExpand Asynchronous plain-text extraction from documents — request body — body file id or url value
file_id_or_url (anyOf 2)nullAlternative
extract_typeModelRequired within parentExpand Asynchronous content extraction from a single file — request body — body extract type

Referenced models: Asynchronous content extraction from a single file — request body — body extract type, Asynchronous plain-text extraction from documents — request body — body file id or url value

Asynchronous content extraction from a single file — request body — body extract type
FieldTypePresenceDescription and constraints
$JSONRootWhat to extract from the source file, with that extraction's options. Exactly one variant must be set. Every variant carries an options message, so always send the object form -- for example `{".tag": "text"}` -- rather than a bare tag string. Option fields may be omitted to take their defaults.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: markdown
$ (anyOf 1).enable_ocrbooleanOptional
$ (anyOf 1).embed_imagesbooleanOptional
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: text
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: ocr
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: transcript
$ (anyOf 4).timestamp_levelModelOptionalExpand Asynchronous transcript generation for audio and video files — request body — body timestamp level
$ (anyOf 4).included_special_wordsstringOptional
$ (anyOf 4).audio_languagestringOptional
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: keyframes
$ (anyOf 5).scene_change_thresholdnumberOptional
$ (anyOf 5).include_imagesbooleanOptional
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:markdown|text|ocr|transcript|keyframes)$)

Referenced models: Asynchronous transcript generation for audio and video files — request body — body timestamp level

Asynchronous plain-text extraction from documents — request body — body file id or url value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: file_id
$ (anyOf 1).file_idstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: url
$ (anyOf 2).urlstringRequired within parent
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: path
$ (anyOf 3).pathstringRequired within parent
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:file_id|url|path)$)
Asynchronous transcript generation for audio and video files — request body — body timestamp level
FieldTypePresenceDescription and constraints
$JSONRootGranularity of the time offsets returned for each transcript segment.
$ (anyOf 1)stringAlternativeOne of: sentence, word
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: sentence
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: word
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:sentence|word)$)

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.