| rank | related_endpoints | related_guides | required_guides | alias_paths | |||||
|---|---|---|---|---|---|---|---|---|---|
7 |
|
|
|
A text representation provides a way to extract plain text from a document.
Text is generated for all document file types including plain text and code files supported by Box. This does not include image files as these do not have a text layer.
Text representations are generated upon upload of the file, similarly to PDFs and thumbnails. They are not generated for files larger than 500 megabytes.
To get a text representation follow the following steps
- List all representations
- Request a text representation by passing the
x-rep-hints-header with the value[extracted_text]. - Download the text by calling the
url_template, replacing the{+asset_path}with an empty string.