Box

Batch process all your records to store structured outputs in a Box account.

The requirements are as follows.

1. Access to the Developer Console from your Box enterprise account or Box developer account.

2. A Box Custom App in your Box account, set up to use Server Authentication (with JWT). See Setup with JWT.

3. The appropriate application scopes and advanced features set up for the Box Custom App, as follows:

   • In the Box Custom App, on the Configuration tab, under Application Scopes, check the box titled Write all files and folders stored in Box.
   • In the Box Custom App, on the Configuration tab, under Advanced Features, check the box titled Make API calls using the as-user header.
   • Click Save Changes before continuing.

4. Authorization by a Box Admin in your Box account for the Box Custom App. See App Authorization.

5. Access by your Box account’s source or target folder to your Box Custom App, as follows:

   • In the Box Custom App, on the General Settings tab, copy the Service Account ID (which takes the form AutomationUser_<your-app-service-id>_<a-random-string@boxdevedition.com).
   • Share your Box account’s target folder with the copied service account’s email address as a Co-owner or Editor.
   • Note the remote URL to the target folder, which takes the format box://<path/to/folder/in/account>.

6. The private key configuration JSON file for the Box Custom App, or a string that contains this file’s contents.

   • To download this file, in the Box Custom App, on the Configuration tab, under Add and Manage Public Keys, click Generate a Public/Private Keypair. Store the downloaded private key configuration JSON file in a secure location.

   • To ensure maximum compatibility across Unstructured service offerings, you should give the private key configuration JSON file information to Unstructured as a single-line string that contains the contents of the downloaded private key configuration JSON file (and not the file itself). To print this single-line string, suitable for copying, you can run one of the following commands from your Terminal or Command Prompt. In this command, replace <path-to-downloaded-key-file> with the path to the private key configuration JSON file that you downloaded by following the preceding instructions.

     • For macOS or Linux:

       tr -d '\n' < <path-to-downloaded-key-file>
       

     • For Windows:

       (Get-Content -Path "<path-to-downloaded-key-file>" -Raw).Replace("`r`n", "").Replace("`n", "")
       

The Box connector dependencies:

pip install "unstructured-ingest[box]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

• BOX_APP_CONFIG - The local path to the downloaded private key configuration JSON file for the Box Custom App, or a single-line string that contains the contents of this file, represented by --box-app-config (CLI) or box_app_config (Python).
• BOX_REMOTE_URL - The remote URL to the target folder, represented by --remote-url (CLI) or remote_url (Python).

These environment variables:

• UNSTRUCTURED_API_KEY - Your Unstructured API key value.
• UNSTRUCTURED_API_URL - Your Unstructured API URL.

Now call the Unstructured CLI or Python SDK. The source connector can be any of the ones supported. This example uses the local source connector: