Attachments

Types & Sources

Supported attachment kinds, source fields, mutual exclusivity rules, and metadata

Supported Types

TypePurposeAccepted Sources
imageVision models and screenshotsurl, urls, path, paths
pdfDocuments; extracted to text when possibleurl, urls, path, paths
audioAudio clips for transcription/analysisurl, urls, path, paths
videoShort videos for multimodal modelsurl, urls, path, paths
fileGeneric files; text files become text partspath, paths
urlReference to an absolute HTTP(S) URLurl

Source Fields (Mutually Exclusive)

Exactly one of these fields must be provided for an attachment that supports multiple sources:

  • 1
    Single value

    url or path

  • 2
    Multiple values

    urls or paths (expanded into many attachments)

Base Fields

FieldRequiredDescription
nameOptionalFriendly label for tooling and logs; supports templating
mimeOptionalHint for content type overrides; validated against allow-lists
metaOptionalArbitrary 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

Cross‑References