PDF to JSON C#

Take your ConvertAPI C# integrations to the next level with advanced techniques for real-world, production-grade document conversion workflows.

These advanced patterns help you build robust, scalable, and efficient PDF to JSON pipelines in your .NET applications while maintaining flexibility and control over your document workflows.

Convert a Remote PDF File

The following C# example demonstrates how to convert a PDF file hosted online (accessible via a public URL) directly to JSON using ConvertAPI. This is useful when your documents are already stored on cloud storage (S3, Azure Blob, etc.) and you want to convert them without downloading locally first.

In this example:

• No local download needed before conversion.
• The PDF file is fetched from the provided URL.
• ConvertAPI converts it to JSON and saves it to a temporary folder on your server or local machine.
• Ideal for server-side processing pipelines and automated workflows.

var convertApi = new ConvertApi("api_key");
var sourceFile = new Uri("https://cdn.convertapi.com/public/files/demo.pdf");

Console.WriteLine($"Converting online {sourceFile} document to JSON...");

var pdfToJsonResult = await convertApi.ConvertAsync("pdf", "json", new ConvertApiFileParam(sourceFile));
var outputFileName = pdfToJsonResult.Files[0];
var fileInfo = await outputFileName.SaveFileAsync(Path.Combine(Path.GetTempPath(), outputFileName.FileName));

Console.WriteLine("The JSON result saved to " + fileInfo);

Convert a PDF File Stream to JSON and Receive a File Stream

This C# example demonstrates how to convert a PDF file provided as a stream directly to JSON using ConvertAPI and receive the converted JSON as a stream without writing to disk. This is ideal for in-memory processing in ASP.NET APIs, serverless functions, or pipeline services where you need to handle documents securely and efficiently.

In this example:

• You pass a PDF file stream (pdf_stream) with a filename hint to ConvertAPI.
• ConvertAPI converts the document to JSON without saving intermediate files.
• The converted JSON is returned as a stream (outputStream) for direct processing, returning to clients, or further manipulation in your pipeline.
• Ideal for secure, diskless document conversion workflows.

var conversionResult = await convertApi.ConvertAsync("pdf", "json",
new ConvertApiFileParam(pdf_stream, "test.pdf")
);
var outputStream = await conversionResult.Files.First().FileStreamAsync();

Console.Write(new StreamReader(outputStream).ReadToEnd());
Console.WriteLine("End of file stream.");

Handling Exceptions During PDF to JSON Conversion

This C# example shows how to handle exceptions when converting a PDF file to JSON using ConvertAPI. By catching ConvertApiException, you can access detailed error information, making it easier to debug issues such as invalid API tokens, unsupported file formats, or conversion errors in your workflow.

In this example:

• A try-catch block safely wraps the PDF to JSON conversion.
• If the API call fails, ConvertApiException provides the HTTP status code and API response details for clear diagnostics.
• This approach ensures your application can handle errors gracefully, log issues, and respond with meaningful messages to users or calling services.

try
{
    var convertApi = new ConvertApi("api_token");
    const string sourceFile = @"..\..\..\TestFiles\test.pdf";

    var convert = await convertApi.ConvertAsync("pdf", "json",
    new ConvertApiFileParam(sourceFile));
}
//Catch exceptions and write details
catch (ConvertApiException e)
{
    Console.WriteLine("Status Code: " + e.StatusCode);
    Console.WriteLine("Response: " + e.Response);
}