Skip to content

Commit 27c7584

Browse files
Merge pull request #625 from scalekit-inc/preview/box-file-tools
Add box_file_representations_get tool to Box connector docs
2 parents 829ed35 + ecbb2b3 commit 27c7584

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

  • src
    • content/docs/reference/agent-connectors
    • data/agent-connectors

src/content/docs/reference/agent-connectors/box.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Enable the corresponding Box app scopes before calling tools that need them:
6666

6767
| Tools | Required scope |
6868
|-------|---------------|
69-
| All file/folder read tools | `root_readonly` |
69+
| All file/folder read tools, `box_file_representations_get` | `root_readonly` |
7070
| File/folder create, update, delete | `root_readwrite` |
7171
| `box_group_*`, `box_user_memberships_list` | `manage_groups` |
7272
| `box_webhook_*`, `box_webhooks_list` | `manage_webhook` |
@@ -135,6 +135,24 @@ Retrieves a thumbnail image for a file.
135135
| `min_width` | integer | No | Minimum width of the thumbnail in pixels. |
136136
| `min_height` | integer | No | Minimum height of the thumbnail in pixels. |
137137

138+
## `box_file_representations_get`
139+
140+
Retrieves available representations for a file, such as PDFs, extracted text, or image thumbnails. Box generates representations on demand — poll until the `status` is `success` before downloading.
141+
142+
| Name | Type | Required | Description |
143+
| --- | --- | --- | --- |
144+
| `file_id` | string | Yes | ID of the file. Get it from `box_folder_items_list`. |
145+
| `x_rep_hints` | string | Yes | Representation formats to request, e.g. `[pdf][extracted_text]` or `[jpg?dimensions=320x320]`. Multiple formats can be combined. |
146+
147+
<Aside type="tip" title="Common x_rep_hints values">
148+
| Value | Description |
149+
|-------|-------------|
150+
| `[pdf]` | PDF version of the file |
151+
| `[extracted_text]` | Plain text extracted from the file |
152+
| `[jpg?dimensions=320x320]` | JPEG thumbnail at 320×320 pixels |
153+
| `[pdf][extracted_text]` | Request multiple representations at once |
154+
</Aside>
155+
138156
### Folders
139157

140158
## `box_folder_get`

src/data/agent-connectors/box.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,24 @@ export const tools: Tool[] = [
389389
description: `Retrieves all tasks associated with a file.`,
390390
params: [{ name: 'file_id', type: 'string', required: true, description: `ID of the file.` }],
391391
},
392+
{
393+
name: 'box_file_representations_get',
394+
description: `Retrieves available representations for a file, such as PDFs, extracted text, or image thumbnails. Box generates representations on demand — poll until status is success before downloading.`,
395+
params: [
396+
{
397+
name: 'file_id',
398+
type: 'string',
399+
required: true,
400+
description: `ID of the file. Get it from box_folder_items_list.`,
401+
},
402+
{
403+
name: 'x_rep_hints',
404+
type: 'string',
405+
required: true,
406+
description: `Representation formats to request, e.g. [pdf][extracted_text] or [jpg?dimensions=320x320]. Multiple formats can be combined.`,
407+
},
408+
],
409+
},
392410
{
393411
name: 'box_file_thumbnail_get',
394412
description: `Retrieves a thumbnail image for a file.`,

0 commit comments

Comments
 (0)