Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.automagik.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Media Processing Pipeline

Omni processes incoming media automatically — transcribing audio, describing images, extracting text from documents. The pipeline is designed for resilience with circuit breakers, retry logic, and health metrics.

​
Processing Flow

Message with media arrives
        │
        ▼
  Download media file
        │
        ▼
  Detect media type (image, audio, video, document)
        │
        ▼
  Route to processor
        │
  ┌─────┼─────────┬──────────────┐
  │     │         │              │
  ▼     ▼         ▼              ▼
Image  Audio    Video        Document
desc   transcr  desc+transcr  extraction
  │     │         │              │
  └─────┴─────────┴──────────────┘
        │
        ▼
  Store result on message record
  (transcription / description fields)

​
Processors

TypeWhat It DoesOutput Field
ImageAI-powered image descriptiondescription
AudioSpeech-to-text transcriptiontranscription
VideoFrame extraction + audio transcriptiondescription + transcription
DocumentPDF/DOCX text extraction + AI summarizationdescription

​
Prompt Overrides

Each processor uses a configurable LLM prompt. You can override the defaults: 
# View current prompts
omni prompts list

# Customize the image description prompt
omni prompts set image "Describe this image in detail, focusing on text content and UI elements."

# Reset to default
omni prompts reset image
Available prompt names: image, video, document, gate.

​
Circuit Breaker

The media pipeline uses a circuit breaker pattern to prevent cascading failures when the AI backend is down or slow:
StateBehavior
ClosedNormal operation — all requests go through
OpenBackend is failing — requests are short-circuited, no API calls made
Half-OpenTesting recovery — a few requests are sent to check if the backend is back
When the circuit is open, messages are stored without media processing. They can be reprocessed later via batch operations.

​
Retry Logic

Failed processing attempts are retried with exponential backoff. After max retries, the message is stored without processed media and flagged for batch reprocessing.

​
Health Metrics

Monitor media processing health: 
# Check overall event metrics
omni events metrics

# View journey timing for a specific message
omni journey show <correlation-id>

​
Batch Processing

For bulk media operations — reprocess failed items, process historical messages, or run ad-hoc transcription: 
# Estimate the job scope and cost
omni batch estimate --instance <id> --since 30d --type audio

# Create a batch job
omni batch create --instance <id> --since 30d --type audio

# Check progress
omni batch status <job-id>

# Cancel if needed
omni batch cancel <job-id>

​
Media Storage

Downloaded media files are stored locally at: 
~/.omni/data/media/<instance-id>/YYYY-MM/<message-id>.<ext>
Browse and download media: 
omni media list --instance <id>
omni media download --id <media-id>
Media files persist on disk indefinitely until you run a cleanup. On a busy instance the ~/.omni/data/media/ tree grows unbounded — schedule periodic pruning if you do not need full media history.

​
See also

Messaging

omni media list, download, and inline TTS via omni send --tts.

Batch processing

omni batch for bulk transcription and description backfills.

Voice gateway

Real-time voice streaming and DAVE-protected sessions.

Providers

Configure Gemini, ElevenLabs, and Groq for transcription and TTS.