Dropbox: Returns the status or result of specified get ocr async task

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

Operation dropbox.riviera_get_ocr_async_check

Provider route: POST /2/riviera/get_ocr_async/check. 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"]["getOcrAsyncCheck"]>[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.getOcrAsyncCheck(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_check(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 Check the status of a save url job — request body — body

Referenced models: Check the status of a save url job — request body — body, Deletes a group — request body — headers Dropbox-API-Path-Root

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 Returns the status or result of specified get ocr async task — response body

Referenced models: Returns the status or result of specified get ocr async task — response body

Schemas

Check the status of a save url job — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for methods that poll the status of an asynchronous job.
`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)$)

Returns the status or result of specified get ocr async task — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Result type for EventBus async check - must end in "CheckResult"
`$ (anyOf 1)`	string	Alternative	Known values: in_progress
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: in_progress
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: complete
`$ (anyOf 3).text`	string	Optional
`$ (anyOf 3).hocr`	string	Optional
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: failed
`$ (anyOf 4).failed`	Model	Required within parent	Expand Returns the status or result of specified get ocr async task — response body — tag failed failed
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:in_progress\|complete\|failed)$)

Referenced models: Returns the status or result of specified get ocr async task — response body — tag failed failed

Returns the status or result of specified get ocr async task — response body — tag failed failed

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason an OCR extraction job failed. Returned in the `failed` variant of `GetOcrAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.
`$ (anyOf 1)`	string	Alternative	Known values: unsupported_format_error, link_download_disabled_error, shared_link_password_protected, limit_exceeded_error, conversion_failure_error, not_found_error, is_a_folder_error
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: server_error
`$ (anyOf 2).server_error`	string	Required within parent
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: user_error
`$ (anyOf 3).user_error`	string	Required within parent
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: unsupported_format_error
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: link_download_disabled_error
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: shared_link_password_protected
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: limit_exceeded_error
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: conversion_failure_error
`$ (anyOf 9)`	object	Alternative
`$ (anyOf 9)..tag`	string	Required within parent	Must equal: not_found_error
`$ (anyOf 10)`	object	Alternative
`$ (anyOf 10)..tag`	string	Required within parent	Must equal: is_a_folder_error
`$ (anyOf 11)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 11)..tag`	string	Required within parent	Pattern: ^(?!(?:server_error\|user_error\|unsupported_format_error\|link_download_disabled_error\|shared_link_password_protected\|limit_exceeded_error\|conversion_failure_error\|not_found_error\|is_a_folder_error)$)

Policy, approvals and errors

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