very-good-ffmpeg
Python SDK for the Very Good FFmpeg API — run FFmpeg jobs in the cloud.
Installation
pip install very-good-ffmpeg
Usage
import os
from very_good_ffmpeg import VGF
client = VGF(os.environ["VGFFMPEG_API_KEY"])
# Create a job and wait for it to complete
job = client.run(
input_files={"input.mp4": "https://example.com/input.mp4"},
output_files=["output.mp4"],
ffmpeg_commands=["-i inputs/input.mp4 -vf scale=1280:720 outputs/output.mp4"],
wait=True,
)
print(job.status) # "succeeded"
print(job.output_files) # {"output.mp4": "https://..."}
Async is also supported — use arun, jobs.aget, jobs.alist, jobs.acancel, files.aupload, etc.
import asyncio, os
from very_good_ffmpeg import VGF
async def main():
client = VGF(os.environ["VGFFMPEG_API_KEY"])
job = await client.arun(
input_files={"input.mp4": "https://example.com/input.mp4"},
output_files=["output.mp4"],
ffmpeg_commands=["-i inputs/input.mp4 -vf scale=1280:720 outputs/output.mp4"],
wait=True,
)
print(job.status)
asyncio.run(main())
Reference
Create a job — client.run(...) / client.arun(...)
Submits an FFmpeg job. Pass wait=True to block until the job reaches a terminal state.
job = client.run(
input_files={"input.mp4": "https://example.com/input.mp4"},
output_files=["output.mp4"],
ffmpeg_commands=["-i inputs/input.mp4 -c:v libx264 outputs/output.mp4"],
webhook_url="https://example.com/webhook", # optional
machine="nvidia", # optional: "cpu" | "nvidia"
wait=True,
)
See Running Commands for the full request shape.
Get a job — client.jobs.get(id) / client.jobs.aget(id)
job = client.jobs.get("job_abc123")
print(job.status) # "queued" | "running" | "succeeded" | "failed" | "cancelled"
List jobs — client.jobs.list(...) / client.jobs.alist(...)
Returns a JobList with data (list of jobs) and paging_params.
result = client.jobs.list(limit=20, offset=0)
print(result.data) # list[Job]
print(result.paging_params) # PagingParams(limit=20, offset=0, total=100, has_more=True)
Cancel a job — client.jobs.cancel(id) / client.jobs.acancel(id)
job = client.jobs.cancel("job_abc123")
print(job.status) # "cancelled"
Poll until done — job.wait(...) / job.async_wait(...)
job = client.run(input_files=..., output_files=..., ffmpeg_commands=...)
job.wait(timeout=120)
print(job.status)
Upload a file — client.files.upload(data, content_type?) / client.files.aupload(...)
Upload bytes or a file path to temporary storage and get back a URL you can use as an input_files value.
with open("input.mp4", "rb") as f:
download_url = client.files.upload(f.read(), "video/mp4")
job = client.run(
input_files={"input.mp4": download_url},
output_files=["output.mp4"],
ffmpeg_commands=["-i inputs/input.mp4 -vf scale=1280:720 outputs/output.mp4"],
)
Pass a file path directly to have the SDK read it for you:
download_url = client.files.upload("input.mp4")
Prepare upload — client.files.prepare() / client.files.aprepare()
Returns a TmpFile with upload_url and download_url if you need to stream a large file yourself.
tmp = client.files.prepare()
# PUT your file to tmp.upload_url, then use tmp.download_url as input
Referencing files in commands
Inputs are downloaded to inputs/ and outputs are uploaded from outputs/, so reference
them as plain paths — the key in input_files and the entry in output_files are the
filenames.
input_files={"input.mp4": "https://example.com/input.mp4"},
output_files=["output.wav"],
ffmpeg_commands=["-i inputs/input.mp4 -vn outputs/output.wav"],
See File Reference Styles for more.
Examples
See examples/example/main.py for a runnable example covering both sync and async usage.
cd examples/example
pip install -r requirements.txt
VGFFMPEG_API_KEY=your_key python main.py
Support
Open an issue at github.com/verygoodffmpeg/Very-Good-FFmpeg-Python-SDK or email please_help@verygoodffmpeg.com.
Metadata
Release files for very-good-ffmpeg 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| very_good_ffmpeg-1.2.1.tar.gz | 3.8 MB | With provenance | Details for very_good_ffmpeg-1.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| very_good_ffmpeg-1.2.1-py3-none-any.whl | Python 3 | none | any | Details for very_good_ffmpeg-1.2.1-py3-none-any.whl |
Total release size: 3.8 MB
Release files / very_good_ffmpeg-1.2.1.tar.gz
| Download URL | very_good_ffmpeg-1.2.1.tar.gz |
|---|---|
| Size | 3.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4543ed1007ace96afd93a60e8c60f18214fc81e5848dfba271bfb91a96763bb4
|
|
BLAKE2b-256 checksum How to use checksums |
32bb83e18e2e6daf18b37cc917a6be329778b2d9f1439641282b7210bb1a95e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logRelease files / very_good_ffmpeg-1.2.1-py3-none-any.whl
| Download URL | very_good_ffmpeg-1.2.1-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
71a90daf09b86ca668c0b2541c2391fe6b99400ba3df32eb0d41bf5dc5326c41
|
|
BLAKE2b-256 checksum How to use checksums |
00b74c661eb24d7eca3b7dff8d3a8ef047eb1d12890b5ecdcae4105fe20b64ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logSecurity for very-good-ffmpeg 1.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for very_good_ffmpeg-1.2.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.