API Reference

High-level summary of endpoints. See detailed pages for usage. You can also use the OpenAPI spec for more details.

FFmpeg

• POST /ffmpeg/process — process an FFmpeg task using file_path inputs
  • Request: { task: { inputs[], outputs[], filter_complex? } }
  • Response: { ok, result[], usage }
• POST /ffmpeg/run — deprecated; use /ffmpeg/process instead

Files

• POST /file — register a file and get presigned PUT URL
  • Request: { file_name, dir_id? }
  • Response: { ok, file { dir_id, file_name, file_path, added_on }, upload { url, method, headers?, expiresInSeconds } }

Directories

• POST /directory — create a temporary working directory (optional)
  • Request: { ttl? }
  • Response: { ok, directory { id, ttl } }
• GET /directory — list your directories
  • Response: { ok, directories[] }
• GET /directory/{dirId} — list files in your directory
  • Response: { ok, files[] }

Auth

All endpoints require Authorization: Basic <API_KEY>. See Authentication.

Errors

Error responses follow { ok: false, error: string } with status-specific messages. See Processing for common errors.