Skip to main content

Documentation Index

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

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

metadata

Read all metadata (EXIF, IPTC, XMP) from a file.
{ "type": "pipeline_metadata" }
Returns a JSON object with all metadata fields.

strip_metadata

Remove all metadata from a file (privacy, file size reduction).
{ "type": "pipeline_strip-metadata" }

file_inspect

Inspect file type, size, and basic properties without processing.
{ "type": "pipeline_file-inspect" }
Returns file type (MIME), size, and format-specific details.

Combined Pipeline Operations

These advanced operations combine multiple tools (FFmpeg + libvips) in a single job.

sprite_sheet

Generate a sprite sheet from video frames (useful for video scrubbing).
{ "type": "pipeline_sprite-sheet", "params": { "columns": 10, "width": 160, "interval": 5 } }

contact_sheet

Generate a contact sheet (grid of thumbnails) from a video.
{ "type": "pipeline_contact-sheet", "params": { "columns": 4, "rows": 4, "width": 1920 } }

social_media_pack

Generate optimized versions for multiple social media platforms.
{ "type": "pipeline_social-media-pack", "params": { "platforms": ["instagram", "twitter", "facebook"] } }

responsive_image_set

Generate multiple sizes for responsive web design.
{ "type": "pipeline_responsive-image-set", "params": { "widths": [320, 640, 1024, 1920] } }

smart_thumbnail

Automatically select the best frame from a video for a thumbnail.
{ "type": "pipeline_smart-thumbnail", "params": { "width": 1280 } }

video_watermark

Add an image watermark to a video (persistent across all frames).
{ "type": "pipeline_video-watermark", "params": { "watermark_url": "https://example.com/logo.png", "position": "bottom-right" } }

animated_preview

Generate an animated GIF/WebP preview from key moments in a video.
{ "type": "pipeline_animated-preview", "params": { "duration": 5, "format": "webp" } }

podcast_visual

Generate a visual waveform video from an audio file (for social media sharing).
{ "type": "pipeline_podcast-visual", "params": { "background_color": "#1a1a2e", "wave_color": "#e94560" } }

document_preview

Generate preview images from document pages.
{ "type": "pipeline_document-preview", "params": { "pages": 3, "width": 800 } }

qc_report

Generate a quality control report for a video file (bitrate graph, codec info, frame analysis).
{ "type": "pipeline_qc-report" }