RunConvert 0.1.0

dotnet add package RunConvert --version 0.1.0
                    
NuGet\Install-Package RunConvert -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RunConvert" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RunConvert" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="RunConvert" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RunConvert --version 0.1.0
                    
#r "nuget: RunConvert, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RunConvert@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RunConvert&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=RunConvert&version=0.1.0
                    
Install as a Cake Tool

RunConvert SDK for .NET

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

dotnet add package RunConvert
using RunConvert;

using var rc = new RunConvertClient(); // reads RUNCONVERT_API_KEY

// One call: upload, convert, wait, download.
var result = await rc.ConvertAsync("report.docx", new ConvertOptions { To = "pdf", OutDir = "out" });
Console.WriteLine(string.Join(", ", result.Saved)); // out/report.pdf

Get an API key in Dashboard → API Keys on runconvert.com. Keep keys on the server. With dependency injection, register one RunConvertClient as a singleton (or pass an HttpClient from IHttpClientFactory).

Convert

// From a URL (imported by RunConvert, nothing to upload)
await rc.ConvertAsync("https://example.com/talk.mp4", new ConvertOptions { To = "mp3", Options = new() { ["audioBitrate"] = "192k" } });

// Progress and a time limit
await rc.ConvertAsync("movie.mov", new ConvertOptions { To = "mp4", OutDir = "out", Timeout = TimeSpan.FromMinutes(10), OnUpdate = job => Console.WriteLine(job.Status) });

Jobs with your own tasks

// Merge two PDFs
var job = await rc.Jobs.CreateAsync(new Dictionary<string, object?>
{
    ["a"] = Tasks.ImportUrl("https://example.com/cover.pdf"),
    ["b"] = Tasks.ImportUrl("https://example.com/body.pdf"),
    ["merge"] = Tasks.Convert("pdf", "pdf", new[] { "a", "b" }),
    ["export"] = Tasks.ExportUrl("merge"),
}, tag: "merge");
job = await rc.Jobs.WaitAsync(job.Id);
foreach (var f in job.ExportedFiles()) await rc.Files.DownloadAsync(f, "out");

// Upload your own file
var upload = await rc.Jobs.CreateAsync(new Dictionary<string, object?>
{
    ["upload"] = Tasks.ImportUpload(),
    ["convert"] = Tasks.Convert("png", "webp", "upload", new Dictionary<string, object?> { ["image_quality"] = 80 }),
    ["export"] = Tasks.ExportUrl("convert"),
});
await rc.Files.UploadAsync(upload.Task("upload")!.UploadUrl!, "image.png");
Method What it does
rc.Jobs.CreateAsync / GetAsync / ListAsync / AllAsync / WaitAsync / CancelAsync / DeleteAsync Jobs, with paging and polling
rc.Files.UploadAsync(url, path or stream) / DownloadAsync(file, dir) Transfers
rc.Operations.ListAsync() / ForInputAsync("mp4") / ForPairAsync("mp4", "mp3") Formats, targets, engines as JsonNode (no key needed)
rc.MeAsync() Account, team and credit balance

Webhooks

app.MapPost("/webhooks/runconvert", async (HttpRequest req) =>
{
    using var ms = new MemoryStream();
    await req.Body.CopyToAsync(ms);
    try
    {
        var ev = Webhooks.ConstructEvent(ms.ToArray(), req.Headers["X-RunConvert-Signature"], Environment.GetEnvironmentVariable("RUNCONVERT_WEBHOOK_SECRET")!);
        if ((string?)ev["event"] == "job.finished") { /* … */ }
        return Results.Ok();
    }
    catch (ArgumentException) { return Results.BadRequest(); }
});

Errors

Exception When
RunConvertException The API said no: Status, Code (e.g. BILLING_INSUFFICIENT_CREDITS), Message
JobFailedException The job ended in error; Task has Code, Reason, Message
WaitTimeoutException WaitAsync ran past its timeout

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

Development

dotnet test --filter "Category!=Live"                                   # no network
RUNCONVERT_API_KEY=rc_live_… dotnet test --filter "Category=Live"       # real API, about 2 credits

License

MIT

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 0 11/15/2026