Skip to navigation
Riviera APIRiviera

Get Markdown Async

Preview
View as Markdown

Asynchronous document-to-markdown conversion for supported file formats.

Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, .gsheet, .ods, .pdf. Files in other formats fail with MarkdownConversionApiV2Error.user_error.

Size limit: the source file must be at most 50 MB. Larger files fail with MarkdownConversionApiV2Error.user_error.

The markdown is not returned by this route. Poll get_markdown_async/check with the returned async job ID until it reports GetMarkdownAsyncCheckResult.complete or GetMarkdownAsyncCheckResult.failed.

Required scope: files.content.read

Endpoint format: RPC

Authentication: App, User

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

App-level OAuth 2.0 token (no user context). Use Authorization: Bearer <token>.

Obtain by calling the token endpoint with grant_type=client_credentials.

Only available on endpoints that declare app auth support.

OR
AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Dropbox-API-Select-UserstringOptional

Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as dbmid:.... When used with a team token, that token must also include the team_data.member scope.

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Request

This endpoint expects a nullable object.
embed_imagesbooleanOptional
When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.
enable_ocrbooleanOptional
Enable OCR for PDF documents. Processing is slower when enabled.
file_id_or_urlobject or nullOptional

Identifier of the document to convert. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats fail with MarkdownConversionApiV2Error.user_error.

Variant:
riviera_api_v2.FileIdOrUrl.file_idobjectRequired

A Dropbox-issued file ID for a file the authenticated user has access to, e.g. “id:a4ayc_80_OEAAAAAAAAAYa”.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
Variant:
async_common.LaunchResultBase.async_job_idobject
This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error