Dropbox: Riviera schemas

39 Dropbox schemas with complete fields and constraints.

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 document-to-markdown conversion for supported file formats — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous get_markdown_async route. Exactly one of FileIdOrUrl.file_id, FileIdOrUrl.path, or FileIdOrUrl.url must be supplied via GetMarkdownArgs.file_id_or_url to identify the document to convert to markdown.
`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
`enable_ocr`	boolean	Optional
`embed_images`	boolean	Optional

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

Asynchronous file metadata extraction for supported file formats — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous get_metadata_async route. Exactly one of FileIdOrUrl.file_id, FileIdOrUrl.path, or FileIdOrUrl.url must be supplied via GetMetadataArgs.file_id_or_url to identify the file whose metadata should be extracted.
`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 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 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 thumbnail format, mode, size format

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The encoding of the produced image. These match `files/get_thumbnail`'s formats: JPEG is the better choice for photographs, PNG for screenshots, line art, and anything with sharp text edges or transparency.
`$ (anyOf 1)`	string	Alternative	One of: jpeg, png, webp
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: jpeg
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: png
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: webp
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:jpeg\|png\|webp)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	How to resize and crop the source to reach the requested `ThumbnailSize`. These match `files/get_thumbnail`'s modes.
`$ (anyOf 1)`	string	Alternative	One of: strict, bestfit, fitone_bestfit, original
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: strict
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: bestfit
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: fitone_bestfit
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: original
`$ (anyOf 6)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 6)..tag`	string	Required within parent	Pattern: ^(?!(?:strict\|bestfit\|fitone_bestfit\|original)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The size of the thumbnail to produce. These are the same named size buckets `files/get_thumbnail` supports, with the same meanings; arbitrary pixel dimensions are not accepted.
`$ (anyOf 1)`	string	Alternative	One of: w32h32, w64h64, w128h128, w256h256, w480h320, w640h480, w960h640, w1024h768, w2048h1536
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: w32h32
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: w64h64
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: w128h128
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: w256h256
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: w480h320
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: w640h480
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: w960h640
`$ (anyOf 9)`	object	Alternative
`$ (anyOf 9)..tag`	string	Required within parent	Must equal: w1024h768
`$ (anyOf 10)`	object	Alternative
`$ (anyOf 10)..tag`	string	Required within parent	Must equal: w2048h1536
`$ (anyOf 11)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 11)..tag`	string	Required within parent	Pattern: ^(?!(?:w32h32\|w64h64\|w128h128\|w256h256\|w480h320\|w640h480\|w960h640\|w1024h768\|w2048h1536)$)

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

Asynchronous plain-text extraction from documents — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous `get_text_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the document whose plain-text content should be extracted.
`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)$)

Asynchronous scene-change keyframe extraction for video files — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous `get_keyframes_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the video whose scene-change keyframes should be extracted.
`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
`scene_change_threshold`	number	Optional
`include_images`	boolean	Optional

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

Asynchronous transcript generation for audio and video files — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for the asynchronous get_transcript_async route. Exactly one of FileIdOrUrl.file_id, FileIdOrUrl.path, or FileIdOrUrl.url must be supplied via GetTranscriptArgs.file_id_or_url to identify the audio or video asset to transcribe.
`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
`timestamp_level`	Model	Optional	Expand Asynchronous transcript generation for audio and video files — request body — body timestamp level
`included_special_words`	string	Optional
`audio_language`	string	Optional

Referenced models: Asynchronous plain-text extraction from documents — request body — body file id or url value, Asynchronous transcript generation for audio and video files — request body — body timestamp level

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Granularity of the time offsets returned for each transcript segment.
`$ (anyOf 1)`	string	Alternative	One of: sentence, word
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: sentence
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: word
`$ (anyOf 4)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 4)..tag`	string	Required within parent	Pattern: ^(?!(?:sentence\|word)$)

Download the output of a completed `get transform async` job — request body — headers Dropbox-API-Arg

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for `download_transform_output`.
`output_handle`	string	Required within parent

Returns the status or result of specified get keyframes 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).frames`	JSON	Optional
`$ (anyOf 3).frames (anyOf 1)`	array	Alternative
`$ (anyOf 3).frames (anyOf 1)[]`	Model	Each item	Expand Returns the status or result of specified get keyframes async task — response body — tag complete frames array item
`$ (anyOf 3).frames (anyOf 2)`	null	Alternative
`$ (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 keyframes 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 keyframes async task — response body — tag complete frames array item, Returns the status or result of specified get keyframes async task — response body — tag failed failed

Returns the status or result of specified get keyframes async task — response body — tag complete frames array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A single extracted scene-change keyframe.
`timestamp`	JSON	Optional
`timestamp (anyOf 1)`	number	Alternative
`timestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`scene_score`	JSON	Optional
`scene_score (anyOf 1)`	number	Alternative
`scene_score (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`image_base64`	string	Optional

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a keyframe extraction job failed. Returned in the `failed` variant of `GetKeyframesAsyncCheckResult`. 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)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Status of a markdown conversion job started by get_markdown_async, as returned by get_markdown_async/check.
`$ (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).markdown`	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 markdown 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 markdown async task — response body — tag failed failed

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a markdown conversion job failed. Returned in the GetMarkdownAsyncCheckResult.failed variant. 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)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Status of a metadata extraction job started by get_metadata_async, as returned by get_metadata_async/check.
`$ (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).metadata_type`	Model	Optional	Expand Returns the status or result of specified get metadata async task — response body — tag complete metadata type
`$ (anyOf 3).metadata`	JSON	Optional
`$ (anyOf 3).metadata (anyOf 1)`	Model	Alternative	Expand Returns the status or result of specified get metadata async task — response body — tag complete metadata value
`$ (anyOf 3).metadata (anyOf 2)`	null	Alternative
`$ (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 metadata 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 metadata async task — response body — tag failed failed, Returns the status or result of specified get metadata async task — response body — tag complete metadata type, Returns the status or result of specified get metadata async task — response body — tag complete metadata value

Returns the status or result of specified get metadata async task — response body — tag complete metadata type

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Which metadata variant is populated in a GetMetadataResult, derived from the file type.
`$ (anyOf 1)`	string	Alternative	Known values: metadata_type_unknown, metadata_type_exif, metadata_type_media, metadata_type_pdf, metadata_type_office
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: metadata_type_unknown
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: metadata_type_exif
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: metadata_type_media
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: metadata_type_pdf
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: metadata_type_office
`$ (anyOf 7)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 7)..tag`	string	Required within parent	Pattern: ^(?!(?:metadata_type_unknown\|metadata_type_exif\|metadata_type_media\|metadata_type_pdf\|metadata_type_office)$)

Returns the status or result of specified get metadata async task — response body — tag complete metadata value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: exif
`$ (anyOf 1).image_width`	JSON	Optional
`$ (anyOf 1).image_width (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).image_width (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).image_height`	JSON	Optional
`$ (anyOf 1).image_height (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).image_height (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).camera_make`	string	Optional
`$ (anyOf 1).camera_model`	string	Optional
`$ (anyOf 1).lens_model`	string	Optional
`$ (anyOf 1).date_time_original`	string	Optional
`$ (anyOf 1).offset_time_original`	string	Optional
`$ (anyOf 1).orientation`	JSON	Optional
`$ (anyOf 1).orientation (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).orientation (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).exposure_time`	string	Optional
`$ (anyOf 1).aperture_value`	JSON	Optional
`$ (anyOf 1).aperture_value (anyOf 1)`	number	Alternative
`$ (anyOf 1).aperture_value (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).iso_speed`	JSON	Optional
`$ (anyOf 1).iso_speed (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).iso_speed (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).focal_length`	string	Optional
`$ (anyOf 1).megapixels`	JSON	Optional
`$ (anyOf 1).megapixels (anyOf 1)`	number	Alternative
`$ (anyOf 1).megapixels (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).artist`	string	Optional
`$ (anyOf 1).copyright`	string	Optional
`$ (anyOf 1).gps_metadata`	JSON	Optional
`$ (anyOf 1).gps_metadata (anyOf 1)`	Model	Alternative	Expand Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag exif gps metadata altitude, datestamp, latitude, longitude, timestamp
`$ (anyOf 1).gps_metadata (anyOf 2)`	null	Alternative
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: media
`$ (anyOf 2).bitrate_bps`	JSON	Optional
`$ (anyOf 2).bitrate_bps (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 2).bitrate_bps (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2).duration_s`	JSON	Optional
`$ (anyOf 2).duration_s (anyOf 1)`	number	Alternative
`$ (anyOf 2).duration_s (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2).creation_time`	string	Optional
`$ (anyOf 2).streams`	JSON	Optional
`$ (anyOf 2).streams (anyOf 1)`	array	Alternative
`$ (anyOf 2).streams (anyOf 1)[]`	Model	Each item	Expand Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag media streams array item
`$ (anyOf 2).streams (anyOf 2)`	null	Alternative
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: pdf
`$ (anyOf 3).pages`	JSON	Optional
`$ (anyOf 3).pages (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 3).pages (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 3).width`	JSON	Optional
`$ (anyOf 3).width (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 3).width (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 3).height`	JSON	Optional
`$ (anyOf 3).height (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 3).height (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: office
`$ (anyOf 4).file_type`	Model	Optional	Expand Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag office file type
`$ (anyOf 4).creator`	string	Optional
`$ (anyOf 4).company`	string	Optional
`$ (anyOf 4).title`	string	Optional
`$ (anyOf 4).subject`	string	Optional
`$ (anyOf 4).keywords`	string	Optional
`$ (anyOf 4).description`	string	Optional
`$ (anyOf 4).total_edit_time_minutes`	JSON	Optional
`$ (anyOf 4).total_edit_time_minutes (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 4).total_edit_time_minutes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 4).pages`	JSON	Optional
`$ (anyOf 4).pages (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 4).pages (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 4).words`	JSON	Optional
`$ (anyOf 4).words (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 4).words (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 4).slides`	JSON	Optional
`$ (anyOf 4).slides (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 4).slides (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 4).revision_number`	string	Optional
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:exif\|media\|pdf\|office)$)

Referenced models: Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag exif gps metadata altitude, datestamp, latitude, longitude, timestamp, Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag media streams array item, Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag office file type

Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag exif gps metadata altitude, datestamp, latitude, longitude, timestamp

Field	Type	Presence	Description and constraints
`$`	object	Root	GPS coordinates and related tags extracted from image EXIF data. Fields are populated on a best-effort basis and may be empty when absent from the source file.
`latitude`	JSON	Optional
`latitude (anyOf 1)`	number	Alternative
`latitude (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`longitude`	JSON	Optional
`longitude (anyOf 1)`	number	Alternative
`longitude (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`altitude`	string	Optional
`timestamp`	string	Optional
`datestamp`	string	Optional

Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag media streams array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A single audio or video stream within a media file.
`index`	JSON	Optional
`index (anyOf 1)`	integer	Alternative	Minimum: 0
`index (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`codec_type`	string	Optional
`codec_name`	string	Optional
`bitrate_bps`	JSON	Optional
`bitrate_bps (anyOf 1)`	integer	Alternative	Minimum: 0
`bitrate_bps (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`duration_s`	JSON	Optional
`duration_s (anyOf 1)`	number	Alternative
`duration_s (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`width`	JSON	Optional
`width (anyOf 1)`	integer	Alternative	Minimum: 0
`width (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`height`	JSON	Optional
`height (anyOf 1)`	integer	Alternative	Minimum: 0
`height (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`frames_per_second`	JSON	Optional
`frames_per_second (anyOf 1)`	number	Alternative
`frames_per_second (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rotation`	JSON	Optional
`rotation (anyOf 1)`	integer	Alternative
`rotation (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`display_aspect_ratio`	string	Optional
`channels`	JSON	Optional
`channels (anyOf 1)`	integer	Alternative	Minimum: 0
`channels (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`channel_layout`	string	Optional
`sample_rate_s`	JSON	Optional
`sample_rate_s (anyOf 1)`	integer	Alternative	Minimum: 0
`sample_rate_s (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`language_iso_639`	string	Optional

Returns the status or result of specified get metadata async task — response body — tag complete metadata value tag office file type

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The kind of MS Office document that produced an ApiOfficeMetadata result.
`$ (anyOf 1)`	string	Alternative	Known values: office_filetype_unknown, office_filetype_word, office_filetype_powerpoint, office_filetype_excel
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: office_filetype_unknown
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: office_filetype_word
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: office_filetype_powerpoint
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: office_filetype_excel
`$ (anyOf 6)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 6)..tag`	string	Required within parent	Pattern: ^(?!(?:office_filetype_unknown\|office_filetype_word\|office_filetype_powerpoint\|office_filetype_excel)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a metadata extraction job failed. Returned in the GetMetadataAsyncCheckResult.failed variant. 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)$)

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

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

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a text extraction job failed. Returned in the `failed` variant of `GetTextAsyncCheckResult`. 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)$)

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Status of a transcript job started by get_transcript_async, as returned by get_transcript_async/check.
`$ (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).structured_transcript`	JSON	Optional
`$ (anyOf 3).structured_transcript (anyOf 1)`	Model	Alternative	Expand Returns the status or result of specified get transcript async task — response body — tag complete structured transcript A transcript, split into segments
`$ (anyOf 3).structured_transcript (anyOf 2)`	null	Alternative
`$ (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 transcript 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 transcript async task — response body — tag complete structured transcript A transcript, split into segments, Returns the status or result of specified get transcript async task — response body — tag failed failed

Returns the status or result of specified get transcript async task — response body — tag complete structured transcript A transcript, split into segments

Field	Type	Presence	Description and constraints
`$`	object	Root	A transcript, split into segments.
`segments`	JSON	Optional
`segments (anyOf 1)`	array	Alternative
`segments (anyOf 1)[]`	Model	Each item	Expand Returns the status or result of specified get transcript async task — response body — tag complete structured transcript A transcript, split into segments segments array item
`segments (anyOf 2)`	null	Alternative
`transcript_locale`	string	Optional

Referenced models: Returns the status or result of specified get transcript async task — response body — tag complete structured transcript A transcript, split into segments segments array item

Returns the status or result of specified get transcript async task — response body — tag complete structured transcript A transcript, split into segments segments array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A contiguous span of transcribed speech. The span covered by a segment depends on the requested TimestampLevel.
`text`	string	Optional
`start_time`	JSON	Optional
`start_time (anyOf 1)`	number	Alternative
`start_time (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`end_time`	JSON	Optional
`end_time (anyOf 1)`	number	Alternative
`end_time (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a transcript job failed. Returned in the GetTranscriptAsyncCheckResult.failed variant. 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: no_audio_error, link_download_disabled_error, shared_link_password_protected, limit_exceeded_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: media_duration_error
`$ (anyOf 4).limit`	JSON	Optional
`$ (anyOf 4).limit (anyOf 1)`	integer	Alternative
`$ (anyOf 4).limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: no_audio_error
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: link_download_disabled_error
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: shared_link_password_protected
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: limit_exceeded_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\|media_duration_error\|no_audio_error\|link_download_disabled_error\|shared_link_password_protected\|limit_exceeded_error\|not_found_error\|is_a_folder_error)$)

Returns the status or result of specified get transform 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).output_handle`	string	Optional
`$ (anyOf 3).size`	JSON	Optional
`$ (anyOf 3).size (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 3).size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 3).format`	string	Optional
`$ (anyOf 3).mime_type`	string	Optional
`$ (anyOf 3).expires_ts`	JSON	Optional
`$ (anyOf 3).expires_ts (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 3).expires_ts (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (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 transform 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 transform async task — response body — tag failed failed

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Reason a transform job failed. Returned in the `failed` variant of `GetTransformAsyncCheckResult`, and by `download_transform_output`. 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, invalid_options_error, expired_handle_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
`$ (anyOf 11)..tag`	string	Required within parent	Must equal: invalid_options_error
`$ (anyOf 12)`	object	Alternative
`$ (anyOf 12)..tag`	string	Required within parent	Must equal: expired_handle_error
`$ (anyOf 13)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 13)..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\|invalid_options_error\|expired_handle_error)$)

Report an issue with this page