Skip to Content
SourcesSandbox

Sandbox

Required
Fields required for a valid configuration.
PathTypeRequiredDescriptionDefaultConstraints
requiredobjectYesSandbox files are uploaded separately through the source files API.no extra properties
Masked
Sensitive fields under(secrets/credentials).
PathTypeRequiredDescriptionDefaultConstraints
maskedobjectNoSandbox sources do not require credentials.no extra properties
Optional
Optional configuration fields.
PathTypeRequiredDescriptionDefaultConstraints
optionalobjectNono extra properties
Extracted Metadata

File

FieldTypeRequiredDescription
size_bytesintegerYesRaw byte size of the content
mime_typestringYesResolved MIME type
parse_errorstringNoSet when content extraction failed
image_widthintegerNoWidth in pixels
image_heightintegerNoHeight in pixels
page_countintegerNoNumber of pages (pdf)
paragraph_countintegerNoNumber of paragraphs (docx)
table_countintegerNoNumber of tables (docx)
row_countintegerNoNumber of data rows
columnsobject[]NoColumns as {name, type} objects (type may be empty for csv/xlsx)
encodingstringNoDetected character encoding
json_root_typestringNoRoot JSON type: object, array, or scalar
top_level_keysintegerNoNumber of top-level keys when the root is an object
array_lengthintegerNoLength when the root is an array
providerstringYesUploaded-file source provider label
object_keystringYesUploaded source file ID
etagstringNoSHA-256 content hash
source_hashstringNoHash of the parent asset (embedded images and archive members only)
locationstringNoLocation within the parent (embedded image location or archive member path)

Image

FieldTypeRequiredDescription
size_bytesintegerYesRaw byte size of the content
mime_typestringYesResolved MIME type
parse_errorstringNoSet when content extraction failed
image_widthintegerNoWidth in pixels
image_heightintegerNoHeight in pixels
providerstringNoUploaded-file source provider label
object_keystringNoUploaded source file ID
etagstringNoSHA-256 content hash
source_hashstringNoHash of the parent asset (embedded images and archive members only)
locationstringNoLocation within the parent (embedded image location or archive member path)

Audio

FieldTypeRequiredDescription
size_bytesintegerYesRaw byte size of the content
mime_typestringYesResolved MIME type
parse_errorstringNoSet when content extraction failed
providerstringYesUploaded-file source provider label
object_keystringYesUploaded source file ID
source_hashstringNoHash of the parent asset (embedded images and archive members only)
locationstringNoLocation within the parent (embedded image location or archive member path)

Video

FieldTypeRequiredDescription
size_bytesintegerYesRaw byte size of the content
mime_typestringYesResolved MIME type
parse_errorstringNoSet when content extraction failed
providerstringYesUploaded-file source provider label
object_keystringYesUploaded source file ID
source_hashstringNoHash of the parent asset (embedded images and archive members only)
locationstringNoLocation within the parent (embedded image location or archive member path)

Archive

FieldTypeRequiredDescription
size_bytesintegerYesRaw byte size of the content
mime_typestringYesResolved MIME type
parse_errorstringNoSet when content extraction failed
providerstringYesUploaded-file source provider label
object_keystringYesUploaded source file ID
etagstringNoSHA-256 content hash
source_hashstringNoHash of the parent asset (embedded images and archive members only)
locationstringNoLocation 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
  }
}