Options reference

Extraction options use one JSON envelope. Use this page for humans and GET /options/{sourceFileType} for machine-readable values.

{
  "extraction": {
    "selectedCapabilities": [
      "video.audio",
      "video.metadata",
      "media.transcript"
    ],
    "includeManifest": true,
    "capabilityOptions": {
      "video.audio": {
        "audioFormat": "mp3"
      },
      "media.transcript": {
        "transcription.mode": "quality"
      }
    }
  }
}

Envelope fields

Field	Type	Default	Notes
`extraction.selectedCapabilities`	array of strings	Source-specific defaults	Capability IDs to include in the ZIP output.
`extraction.includeManifest`	boolean	`true`	Includes a manifest file that lists the produced ZIP entries.
`extraction.capabilityOptions`	object	`{}`	Map of capability ID to option fields for that capability.

Capability reference

Capability	Description	Used by	Options
`archive.images`	Image files found inside the archive.	ZIP	None
`archive.metadata`	Archive structure and file metadata.	ZIP	None
`audio.artwork`	Cover art and attached pictures.	AAC, AIF, AIFF, FLAC, M4A, M4B, MKA, MP3, OGG, OPUS, WAV, WMA	None
`audio.chapterAudio`	Chapter audio files split from markers.	AAC, AIF, AIFF, FLAC, M4A, M4B, MKA, MP3, OGG, OPUS, WAV, WMA	`audioFormat`
`audio.chapters`	Chapter markers exported for review.	AAC, AIF, AIFF, FLAC, M4A, M4B, MKA, MP3, OGG, OPUS, WAV, WMA	None
`audio.metadata`	File information, duration, dates, and embedded tags.	AAC, AIF, AIFF, FLAC, M4A, M4B, MKA, MP3, OGG, OPUS, WAV, WMA	None
`email.embeddedFiles`	Email attachments saved as separate files.	EML	None
`email.images`	Inline email images saved separately.	EML	None
`email.metadata`	Message headers and email metadata.	EML	None
`excel.audio`	Extracted audio files when present.	XLSM, XLSX, XLTM, XLTX	`audioFormat`
`excel.embeddedFiles`	Embedded files recovered as separate files.	XLSM, XLSX, XLTM, XLTX	None
`excel.images`	Original image assets saved as separate files.	XLSM, XLSX, XLTM, XLTX	None
`excel.video`	Extracted video files when present.	XLSM, XLSX, XLTM, XLTX	None
`excel.worksheets`	Worksheet CSV files for analysis or migration.	XLSM, XLSX, XLTM, XLTX	None
`executable.icons`	Embedded Windows icon resources saved as ICO and PNG files.	EXE	None
`image.codes`	QR codes and barcodes found in the file.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`image.colors`	Dominant colors and palette information.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`image.exif`	EXIF-style metadata exported as JSON and CSV.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`image.frames`	Extract frames and timing data when present.	AVIF, AVIFS, GIF, WEBP	`frameIntervalSeconds`, `frameMode`, `maxExtractedFrames`
`image.gps`	GPS coordinates plus a downloadable map when stored in the source file.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`image.icons`	Icon sizes and embedded icon images.	ICO	None
`image.profiles`	ICC profiles and color management data.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`image.text`	Text recognized from screenshots, photos, and scanned images with Fast AI OCR.	AVIF, AVIFS, BMP, GIF, HEIC, HEIF, HIF, ICO, JPEG, JPG, PNG, TIF, TIFF, WEBP	None
`media.transcript`	Create transcripts from speech.	AVI, M4V, MKV, MOV, MP4, WEBM, AAC, AIF, AIFF, FLAC, M4A, M4B, MKA, MP3, OGG, OPUS, WAV, WMA	`transcription.mode`
`pdf.annotations`	PDF comments and markup records when present.	PDF	None
`pdf.embeddedFiles`	Embedded PDF files saved separately.	PDF	None
`pdf.fonts`	Embedded PDF font files when present.	PDF	None
`pdf.forms`	PDF form field data when available.	PDF	None
`pdf.images`	Images embedded in the PDF saved separately.	PDF	None
`pdf.links`	PDF link annotations for review.	PDF	None
`pdf.markdown`	Markdown generated from PDF text.	PDF	None
`pdf.metadata`	PDF document metadata for audit workflows.	PDF	None
`pdf.pages`	Whole PDF pages rendered as image files.	PDF	None
`pdf.text`	Selectable PDF text saved by page.	PDF	None
`powerpoint.audio`	Extracted audio files when present.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	`audioFormat`
`powerpoint.embeddedFiles`	Embedded files recovered as separate files.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.images`	Original image assets saved as separate files.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.markdown`	Markdown generated from slide text and speaker notes.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.notes`	Speaker notes split into readable files.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.slides`	Rendered slide images for preview and review.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.text`	Readable text files for review, migration, or search.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`powerpoint.video`	Extracted video files when present.	POTM, POTX, PPSM, PPSX, PPTM, PPTX	None
`video.artwork`	Cover art and attached pictures when present.	AVI, M4V, MKV, MOV, MP4, WEBM	None
`video.audio`	Extracted audio files when present.	AVI, M4V, MKV, MOV, MP4, WEBM	`audioFormat`
`video.frames`	Extract frames and timing data when present.	AVI, M4V, MKV, MOV, MP4, WEBM	`frameIntervalSeconds`, `frameMode`, `maxExtractedFrames`
`video.metadata`	File information, dimensions, dates, and embedded tags.	AVI, M4V, MKV, MOV, MP4, WEBM	None
`video.subtitles`	Subtitle files extracted from embedded tracks.	AVI, M4V, MKV, MOV, MP4, WEBM	None
`word.audio`	Extracted audio files when present.	DOCM, DOCX, DOTM, DOTX	`audioFormat`
`word.embeddedFiles`	Embedded files recovered as separate files.	DOCM, DOCX, DOTM, DOTX	None
`word.images`	Original image assets saved as separate files.	DOCM, DOCX, DOTM, DOTX	None
`word.markdown`	Markdown preserving document text, headings, links, and tables.	DOCM, DOCX, DOTM, DOTX	None
`word.pages`	Page snapshots ready to skim without opening the document.	DOC, DOCM, DOCX, DOT, DOTM, DOTX	None
`word.text`	Readable text files for review, migration, or search.	DOCM, DOCX, DOTM, DOTX	None
`word.video`	Extracted video files when present.	DOCM, DOCX, DOTM, DOTX	None

audioFormat

Chooses the audio file format when extracting an audio track from video or splitting audio from embedded media.

Property	Value
Type	`enum`
Default	`mp3`
Allowed values	`mp3`, `wav`, `m4a`, `original`, `best`
Limits	None
Used by	`audio.chapterAudio`, `excel.audio`, `powerpoint.audio`, `video.audio`, `word.audio`

Example:

{
  "extraction": {
    "capabilityOptions": {
      "video.audio": {
        "audioFormat": "mp3"
      }
    }
  }
}

frameIntervalSeconds

Sets the interval when frameMode is every-n-seconds.

Property	Value
Type	`number`
Default	`1`
Allowed values	Any value within limits
Limits	0.1 to 300
Used by	`image.frames`, `video.frames`

Example:

{
  "extraction": {
    "selectedCapabilities": [
      "video.frames"
    ],
    "capabilityOptions": {
      "video.frames": {
        "frameMode": "every-n-seconds",
        "frameIntervalSeconds": 5,
        "maxExtractedFrames": 100
      }
    }
  }
}

frameMode

Chooses how frames are selected from video and animated image sources.

Property	Value
Type	`enum`
Default	`evenly-spaced`
Allowed values	`evenly-spaced`, `first`, `every-n-seconds`
Limits	None
Used by	`image.frames`, `video.frames`

Example:

{
  "extraction": {
    "selectedCapabilities": [
      "video.frames"
    ],
    "capabilityOptions": {
      "video.frames": {
        "frameMode": "every-n-seconds",
        "frameIntervalSeconds": 5,
        "maxExtractedFrames": 100
      }
    }
  }
}

maxExtractedFrames

Caps the number of frame image files written into the ZIP.

Property	Value
Type	`integer`
Default	`500`
Allowed values	Any value within limits
Limits	1 to 2000
Used by	`image.frames`, `video.frames`

Example:

{
  "extraction": {
    "selectedCapabilities": [
      "video.frames"
    ],
    "capabilityOptions": {
      "video.frames": {
        "frameMode": "every-n-seconds",
        "frameIntervalSeconds": 5,
        "maxExtractedFrames": 100
      }
    }
  }
}

transcription.mode

Chooses the transcript add-on mode for audio and video speech-to-text output.

Property	Value
Type	`enum`
Default	`fast`
Allowed values	`fast`, `quality`, `meeting-intelligence`
Limits	None
Used by	`media.transcript`

Example:

{
  "extraction": {
    "selectedCapabilities": [
      "media.transcript"
    ],
    "capabilityOptions": {
      "media.transcript": {
        "transcription.mode": "quality"
      }
    }
  }
}

Source type matrix

Source	Format	Capabilities	Capability options
DOC	`doc`	`word.pages`	None
DOCM	`docm`	`word.images`, `word.pages`, `word.text`, `word.markdown`, `word.audio`, `word.video`, `word.embeddedFiles`	`audioFormat`
DOCX	`docx`	`word.images`, `word.pages`, `word.text`, `word.markdown`, `word.audio`, `word.video`, `word.embeddedFiles`	`audioFormat`
DOT	`dot`	`word.pages`	None
DOTM	`dotm`	`word.images`, `word.pages`, `word.text`, `word.markdown`, `word.audio`, `word.video`, `word.embeddedFiles`	`audioFormat`
DOTX	`dotx`	`word.images`, `word.pages`, `word.text`, `word.markdown`, `word.audio`, `word.video`, `word.embeddedFiles`	`audioFormat`
PDF	`pdf`	`pdf.images`, `pdf.pages`, `pdf.text`, `pdf.markdown`, `pdf.embeddedFiles`, `pdf.metadata`, `pdf.links`, `pdf.annotations`, `pdf.forms`, `pdf.fonts`	None
POTM	`potm`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
POTX	`potx`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
PPSM	`ppsm`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
PPSX	`ppsx`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
PPTM	`pptm`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
PPTX	`pptx`	`powerpoint.images`, `powerpoint.slides`, `powerpoint.text`, `powerpoint.markdown`, `powerpoint.notes`, `powerpoint.audio`, `powerpoint.video`, `powerpoint.embeddedFiles`	`audioFormat`
XLSM	`xlsm`	`excel.images`, `excel.worksheets`, `excel.audio`, `excel.video`, `excel.embeddedFiles`	`audioFormat`
XLSX	`xlsx`	`excel.images`, `excel.worksheets`, `excel.audio`, `excel.video`, `excel.embeddedFiles`	`audioFormat`
XLTM	`xltm`	`excel.images`, `excel.worksheets`, `excel.audio`, `excel.video`, `excel.embeddedFiles`	`audioFormat`
XLTX	`xltx`	`excel.images`, `excel.worksheets`, `excel.audio`, `excel.video`, `excel.embeddedFiles`	`audioFormat`
AVIF	`avif`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`, `image.frames`	`frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`
AVIFS	`avifs`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`, `image.frames`	`frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`
BMP	`bmp`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
GIF	`gif`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`, `image.frames`	`frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`
HEIC	`heic`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
HEIF	`heif`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
HIF	`hif`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
ICO	`ico`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`, `image.icons`	None
JPEG	`jpeg`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
JPG	`jpg`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
PNG	`png`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
TIF	`tif`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
TIFF	`tiff`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`	None
WEBP	`webp`	`image.exif`, `image.gps`, `image.codes`, `image.colors`, `image.profiles`, `image.text`, `image.frames`	`frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`
AVI	`avi`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
M4V	`m4v`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
MKV	`mkv`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
MOV	`mov`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
MP4	`mp4`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
WEBM	`webm`	`video.audio`, `video.metadata`, `video.artwork`, `video.subtitles`, `video.frames`, `media.transcript`	`audioFormat`, `frameMode`, `frameIntervalSeconds`, `maxExtractedFrames`, `transcription.mode`
AAC	`aac`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
AIF	`aif`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
AIFF	`aiff`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
FLAC	`flac`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
M4A	`m4a`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
M4B	`m4b`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
MKA	`mka`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
MP3	`mp3`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
OGG	`ogg`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
OPUS	`opus`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
WAV	`wav`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
WMA	`wma`	`audio.metadata`, `audio.artwork`, `audio.chapters`, `audio.chapterAudio`, `media.transcript`	`audioFormat`, `transcription.mode`
ZIP	`zip`	`archive.images`, `archive.metadata`	None
EML	`eml`	`email.embeddedFiles`, `email.images`, `email.metadata`	None
EXE	`exe`	`executable.icons`	None

PreviousDiscovery

NextAll extractors