Attachments
Types & Sources
Supported attachment kinds, source fields, mutual exclusivity rules, and metadata
Supported Types
Type | Purpose | Accepted Sources |
---|---|---|
image | Vision models and screenshots | url , urls , path , paths |
pdf | Documents; extracted to text when possible | url , urls , path , paths |
audio | Audio clips for transcription/analysis | url , urls , path , paths |
video | Short videos for multimodal models | url , urls , path , paths |
file | Generic files; text files become text parts | path , paths |
url | Reference to an absolute HTTP(S) URL | url |
Source Fields (Mutually Exclusive)
Exactly one of these fields must be provided for an attachment that supports multiple sources:
- 1Single value
url
orpath
- 2Multiple values
urls
orpaths
(expanded into many attachments)
Base Fields
Field | Required | Description |
---|---|---|
name | Optional | Friendly label for tooling and logs; supports templating |
mime | Optional | Hint for content type overrides; validated against allow-lists |
meta | Optional | Arbitrary map for adapter hints; currently supports image_detail (low | high | auto ) |
Examples
attachments:
- type: image
url: "https://example.com/sample.png"
name: "hero"
meta:
image_detail: high