Sandbox
Required
Fields required for a valid configuration.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| required | object | Yes | Sandbox files are uploaded separately through the source files API. | — | no extra properties |
Masked
Sensitive fields under(secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | No | Sandbox sources do not require credentials. | — | no extra properties |
Optional
Optional configuration fields.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
Extracted Metadata
File
| Field | Type | Required | Description |
|---|---|---|---|
| size_bytes | integer | Yes | Raw byte size of the content |
| mime_type | string | Yes | Resolved MIME type |
| parse_error | string | No | Set when content extraction failed |
| image_width | integer | No | Width in pixels |
| image_height | integer | No | Height in pixels |
| page_count | integer | No | Number of pages (pdf) |
| paragraph_count | integer | No | Number of paragraphs (docx) |
| table_count | integer | No | Number of tables (docx) |
| row_count | integer | No | Number of data rows |
| columns | object[] | No | Columns as {name, type} objects (type may be empty for csv/xlsx) |
| encoding | string | No | Detected character encoding |
| json_root_type | string | No | Root JSON type: object, array, or scalar |
| top_level_keys | integer | No | Number of top-level keys when the root is an object |
| array_length | integer | No | Length when the root is an array |
| provider | string | Yes | Uploaded-file source provider label |
| object_key | string | Yes | Uploaded source file ID |
| etag | string | No | SHA-256 content hash |
| source_hash | string | No | Hash of the parent asset (embedded images and archive members only) |
| location | string | No | Location within the parent (embedded image location or archive member path) |
Image
| Field | Type | Required | Description |
|---|---|---|---|
| size_bytes | integer | Yes | Raw byte size of the content |
| mime_type | string | Yes | Resolved MIME type |
| parse_error | string | No | Set when content extraction failed |
| image_width | integer | No | Width in pixels |
| image_height | integer | No | Height in pixels |
| provider | string | No | Uploaded-file source provider label |
| object_key | string | No | Uploaded source file ID |
| etag | string | No | SHA-256 content hash |
| source_hash | string | No | Hash of the parent asset (embedded images and archive members only) |
| location | string | No | Location within the parent (embedded image location or archive member path) |
Audio
| Field | Type | Required | Description |
|---|---|---|---|
| size_bytes | integer | Yes | Raw byte size of the content |
| mime_type | string | Yes | Resolved MIME type |
| parse_error | string | No | Set when content extraction failed |
| provider | string | Yes | Uploaded-file source provider label |
| object_key | string | Yes | Uploaded source file ID |
| source_hash | string | No | Hash of the parent asset (embedded images and archive members only) |
| location | string | No | Location within the parent (embedded image location or archive member path) |
Video
| Field | Type | Required | Description |
|---|---|---|---|
| size_bytes | integer | Yes | Raw byte size of the content |
| mime_type | string | Yes | Resolved MIME type |
| parse_error | string | No | Set when content extraction failed |
| provider | string | Yes | Uploaded-file source provider label |
| object_key | string | Yes | Uploaded source file ID |
| source_hash | string | No | Hash of the parent asset (embedded images and archive members only) |
| location | string | No | Location within the parent (embedded image location or archive member path) |
Archive
| Field | Type | Required | Description |
|---|---|---|---|
| size_bytes | integer | Yes | Raw byte size of the content |
| mime_type | string | Yes | Resolved MIME type |
| parse_error | string | No | Set when content extraction failed |
| provider | string | Yes | Uploaded-file source provider label |
| object_key | string | Yes | Uploaded source file ID |
| etag | string | No | SHA-256 content hash |
| source_hash | string | No | Hash of the parent asset (embedded images and archive members only) |
| location | string | No | Location within the parent (embedded image location or archive member path) |
Examples
Uploaded files
Upload local files and scan them through the standard source lifecycle
Config Payload
{
"type": "SANDBOX",
"required": {},
"masked": {},
"optional": {},
"sampling": {
"strategy": "ALL",
"rows_per_page": 100
}
}