Dropbox: Asynchronous OCR (optical character recognition) text extraction for images and PD Fs, including scanned non-text PD Fs

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

Operation dropbox.riviera_get_ocr_async

Provider route: POST /2/riviera/get_ocr_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"]["getOcrAsync"]>[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.getOcrAsync(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_ocr_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 OCR (optical character recognition) text extraction for images and PD Fs, including scanned non-text PD Fs — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Asynchronous OCR (optical character recognition) text extraction for images and PD Fs, including scanned non-text PD Fs — 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

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 OCR (optical character recognition) text extraction for images and PD Fs, including scanned non-text PD Fs — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous `get_ocr_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the image or PDF whose text should be extracted via OCR (optical character recognition).
`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

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

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

Policy, approvals and errors

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