Image to PDF in Go

Overview

Convert images to PDF documents with the PDFCrowd Go client. The client handles communication with the API, while conversions run on PDFCrowd's servers.

Installation

Add the Go client to your module with go get, or see other installation options.

go get github.com/pdfcrowd/pdfcrowd-go

Quick Start

Update the input URLs and filenames as needed.

package main

import (
    "log"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    err := client.ConvertUrlToFile(
        "https://your-server.com/logo.png", "logo.pdf",
    )
    if err != nil {
        log.Print(err)
        return
    }
}

package main

import (
    "log"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    err := client.ConvertFileToFile("logo.png", "logo.pdf")
    if err != nil {
        log.Print(err)
        return
    }
}

Configure a Conversion

Authentication

Pass your PDFCrowd username and API key to NewImageToPdfClient. Find your credentials on the API Keys page.

Choose an Input

The source image format is detected automatically. Each conversion accepts one image.

For a local image or a URL on localhost, upload the file, bytes, or an open binary stream. Remote URLs must be reachable from PDFCrowd's servers.

Send Image Bytes

Read logo.png as bytes, convert it to PDF, and save logo.pdf:

package main

import (
    "log"
    "os"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    image, err := os.ReadFile("logo.png")
    if err != nil {
        log.Print(err)
        return
    }

    err = client.ConvertRawDataToFile(image, "logo.pdf")
    if err != nil {
        log.Print(err)
        return
    }
}

Add Conversion Settings

Set conversion options on the client before calling a conversion method. For example, client.SetPageSize("A4") selects A4 paper.

Common settings are listed below. See the method reference for all available options or browse Go examples.

Image operations change the source image; page settings control the output area and image placement.

With an explicit page size, use SetPrintPageMode() with "fit" to preserve the aspect ratio and fit the image inside the margins. The "stretch" mode fills the area and can distort the image. The default mode does not scale the image to fit and can crop it. Without an explicit size, margins add a border around the image.

Handle the Result

Choose an Output

The PDF contains the source image. Making text in a scan searchable requires a separate OCR step.

The methods below use URL input; local files, bytes, and input streams have corresponding methods.

File-output methods overwrite an existing destination file.

This example converts an image, receives the result as a []byte and saves it as logo.pdf:

package main

import (
    "log"
    "os"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    result, err := client.ConvertUrl("https://your-server.com/logo.png")
    if err != nil {
        log.Print(err)
        return
    }
    if err := os.WriteFile("logo.pdf", result, 0644); err != nil {
        log.Print(err)
        return
    }
}

When serving the result from a web application, use Content-Type: application/pdf.

Handle Errors

Conversion methods return an error. API and validation errors have the type pdfcrowd.Error; local file and connection failures can return other error types. This example converts an image, logs any error, and uses errors.As to read the HTTP status and reason code when available:

package main

import (
    "errors"
    "log"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    err := client.ConvertUrlToFile(
        "https://your-server.com/logo.png", "logo.pdf",
    )
    if err != nil {
        log.Print(err)
        var apiError pdfcrowd.Error
        if errors.As(err, &apiError) {
            log.Printf("Status: %d; reason: %d",
                apiError.GetStatusCode(), apiError.GetReasonCode())
        }
        return
    }
}

pdfcrowd.Error provides these methods:

Error() returns the complete error message, including available status and reason codes.

Common Status Codes

See all status and reason codes for specific explanations and Limits and Retries for retry behavior.

Read Conversion Information

This information is available after a conversion and describes the client's last conversion.

Limits and Retries

Request rate and concurrency limits depend on your license. Control how quickly your application submits conversions and how many it runs at once. A 429 response concerns request rate; a 430 response concerns requests already in progress. The maximum upload size is 300 MB.

The Go client automatically retries a request once when it receives HTTP 502 or 503. Use SetRetryCount() to change that count, or set it to 0 to disable automatic retries. Account for these retries when adding an application-level retry policy.

Troubleshooting

Inspect a Conversion

This example converts an image with debug logging enabled and logs the debug log URL when available. Use the input and settings from the conversion you are investigating.

package main

import (
    "log"
    "github.com/pdfcrowd/pdfcrowd-go"
)

func main() {
    client := pdfcrowd.NewImageToPdfClient("demo", "demo")

    client.SetDebugLog(true)
    defer func() {
        if debugLogURL := client.GetDebugLogUrl(); debugLogURL != "" {
            log.Printf("Debug log: %s", debugLogURL)
        }
    }()

    err := client.ConvertUrlToFile(
        "https://your-server.com/logo.png", "logo.pdf",
    )
    if err != nil {
        log.Print(err)
        return
    }
}

The debug log contains conversion settings and processing details. You can also find logs in your conversion history. A local or connection failure may occur before a conversion log is available.

Common Problems

For help, contact support and include any available diagnostics, the client version, and enough detail to reproduce the problem.