Skip to main content

RunConvert SDK for Python

Convert files between 240+ formats (3,000+ conversions) with the RunConvert API: documents, images, video, audio, ebooks, archives, fonts and CAD. Python 3.10+, no dependencies.

pip install runconvert
from runconvert import RunConvert

rc = RunConvert()  # reads RUNCONVERT_API_KEY

# One call: upload, convert, wait, download.
result = rc.convert("report.docx", "pdf", out_dir="out")
print(result.saved)  # ['out/report.pdf']

Get an API key in Dashboard → API Keys on runconvert.com. Keep keys on the server.

Convert

# From a URL (imported by RunConvert, nothing to upload)
rc.convert("https://example.com/talk.mp4", "mp3", options={"audioBitrate": "192k"})

# From bytes or a file object: give a filename (or from_)
rc.convert(data, "jpg", filename="photo.heic", out_dir="out")

# Progress and a time limit (seconds)
rc.convert("movie.mov", "mp4", out_dir="out", on_update=lambda job: print(job["status"]), timeout=600)

convert returns ConvertResult(job, files, saved). Options for a conversion come from rc.operations.for_pair("mp4", "mp3").

Jobs with your own tasks

from runconvert import Jobs

# Merge three PDFs into one
job = rc.jobs.create({
    "a": {"operation": "import/url", "source_url": "https://example.com/cover.pdf"},
    "b": {"operation": "import/url", "source_url": "https://example.com/body.pdf"},
    "merge": {"operation": "convert", "input": ["a", "b"], "input_format": "pdf", "output_format": "pdf"},
    "export": {"operation": "export/url", "input": "merge"},
}, tag="merge")
done = rc.jobs.wait(job["id"])
for f in Jobs.exported_files(done):
    rc.files.download(f, "out")

# Upload your own file
job = rc.jobs.create({
    "upload": {"operation": "import/direct/upload"},
    "convert": {"operation": "convert", "input": "upload", "input_format": "png", "output_format": "webp", "image_quality": 80},
    "export": {"operation": "export/url", "input": "convert"},
})
upload_task = next(t for t in job["tasks"] if t["name"] == "upload")
rc.files.upload(upload_task, "image.png")
Method What it does
rc.jobs.create(tasks, tag=, metadata=) Create a job (returned with its tasks)
rc.jobs.get(id) / rc.jobs.list(status=, tag=, page=, per_page=) A job / one page {"data", "meta"}
rc.jobs.all(...) Every job: for job in rc.jobs.all()
rc.jobs.wait(id, timeout=, on_update=, raise_on_error=) Poll until finished or error
rc.jobs.cancel(id) / rc.jobs.delete(id) Stop pending tasks / delete
rc.files.upload(task, file) / rc.files.download(file, dir) Upload to a task / save a result
rc.operations.list(category=) / for_input("mp4") / for_pair("mp4", "mp3") Formats, targets, engines (no key needed)
rc.me() Account, team and credit balance

Webhooks

from runconvert import construct_event

@app.post("/webhooks/runconvert")  # Flask
def runconvert_webhook():
    try:
        event = construct_event(request.get_data(), request.headers.get("X-RunConvert-Signature"), os.environ["RUNCONVERT_WEBHOOK_SECRET"])
    except ValueError:
        return "", 400
    if event["event"] == "job.finished":
        print("done", event["job"]["id"])
    return "", 200

Errors

Error When
RunConvertError The API said no: .status, .code (e.g. BILLING_INSUFFICIENT_CREDITS), .message
JobFailedError The job ended in error; .task has code, reason, message
WaitTimeoutError wait ran past its timeout

Network errors, 429 and 5xx are retried twice with backoff (max_retries). Creating a job is only retried when the request never reached the API, so a job is never created twice.

Development

PYTHONPATH=src python3 -m unittest tests.test_unit                          # no network
RUNCONVERT_API_KEY=rc_live_… PYTHONPATH=src python3 -m unittest tests.test_live  # real API, about 2 credits

License

MIT

Metadata

Release files for runconvert 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for runconvert 0.1.0
File Size Uploaded Provenance Actions
runconvert-0.1.0.tar.gz 14.2 kB With provenance Details for runconvert-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for runconvert 0.1.0
File Interpreter ABI Platform Actions
runconvert-0.1.0-py3-none-any.whl Python 3 none any Details for runconvert-0.1.0-py3-none-any.whl

Total release size: 25.6 kB

Release files / runconvert-0.1.0.tar.gz

Download URL runconvert-0.1.0.tar.gz
Size 14.2 kB
Tags Source
SHA-256 checksum
How to use checksums
08295edecfd0a2cdb39478c1bc1f51f774e64a1c5d9ff53ce19f7be2b5039169
BLAKE2b-256 checksum
How to use checksums
bbdf4a4747b78dab32c218f247bb17589c5bac33769bb08f5cd00471d6316028
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 15, 2026.

Transparency log

Release files / runconvert-0.1.0-py3-none-any.whl

Download URL runconvert-0.1.0-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38b8efb208b41a94cd60e2f12d7cd4be36016618eedc54125c2e6293a6519ddc
BLAKE2b-256 checksum
How to use checksums
f1b834d49265c6ff98a4f8bc565d468e6749b47f0796615ad7a858f504c2c6f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 15, 2026.

Transparency log

Security for runconvert 0.1.0

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.

Select from 2 files

Attestation for runconvert-0.1.0.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 Nov 15, 2026.

Transparency log

A 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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page