Image to Image / Golang Reference

Constructor for the PDFCrowd API client. Initialize a new instance of the conversion client with your PDFCrowd account credentials.

You must provide both your username and API key. This establishes the authenticated connection for all subsequent conversion operations.

Convert an image from a URL.

Use this as the primary method for converting web content, online documents, or any publicly accessible URL to the desired output format. Returns the conversion result as a byte array for further processing or direct use.

Convert an image from a URL and write the conversion result directly to an output stream.

Use this when you need to handle large conversion results, integrate with streaming pipelines, or build server applications that process conversions continuously.

Convert an image from a URL and save the conversion result directly to a local file.

Use this for simple file-based workflows, batch processing, or when you need to persist conversion output to disk. The most straightforward method for URL-to-file conversions.

Convert a local file to the desired output format.

Use this for processing files already on your system, converting uploaded documents, or batch processing local content. Returns the conversion result as a byte array for in-memory processing.

Convert a local file and write the conversion result directly to an output stream.

Use this when working with large conversion results, integrating with streaming frameworks, or building applications that need direct stream-to-stream processing.

Convert a local file and save the conversion result to another local file.

Use this for file-based batch processing, document transformation workflows, or when both input and output are file-based. The simplest method for file-to-file conversions.

Convert raw binary data to the desired output format.

Use this for processing binary content, handling file uploads as byte arrays, or when working with data from external APIs. Provides maximum flexibility for binary data conversions.

Convert raw binary data and write the conversion result directly to an output stream.

Use this when handling large binary data with substantial conversion results, integrating with streaming systems, or building high-performance conversion services.

Convert raw binary data and save the conversion result to a local file.

Use this for processing binary uploads and persisting the output, handling data from external sources, or when working with byte array inputs that need file-based storage.

Convert content from an input stream to the desired output format.

Use this when integrating with I/O pipelines, processing data from network streams or file handles, or when the source data is provided as a stream by your application.

Convert content from an input stream and write the conversion result to an output stream.

Use this when both input and output need to be streams, integrating with streaming frameworks, or building conversion services that process data in stream form throughout.

Convert content from an input stream and save the conversion result to a local file.

Use this when processing streaming uploads that need to be saved, handling network data sources with file-based output, or building services that accept stream input and produce file output.

The output file format.

Scale the image to different dimensions. Accepts percentage values for proportional scaling or explicit pixel dimensions for absolute sizing.

Rotate the image by the specified angle in degrees. Positive values rotate clockwise, negative values counterclockwise.

Set the horizontal starting position of the crop area, measured from the left edge of the print area. Positive values offset inward from the left edge, negative values extend beyond the left boundary.

Set the vertical starting position of the crop area, measured from the top edge of the print area. Positive values offset inward from the top edge, negative values extend beyond the top boundary.

Set the horizontal extent of the crop area. Defines the width of the region to be converted. Minimum value is 1 inch.

Set the vertical extent of the crop area. Defines the height of the region to be converted. Minimum value is 1 inch.

Define a rectangular region to convert by setting X/Y position and width/height simultaneously. Coordinates are relative to the print area's top-left corner.

Detect and remove solid-color borders surrounding the image content. Only removes borders that consist of a single consistent color.

Set the output canvas size. Use standard sizes (A4, Letter, A3, etc.) for printable output with consistent dimensions.

Set the output canvas width.

Set the output canvas height.

Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.

Set the output canvas orientation. Use portrait for vertical content, landscape for horizontal or wide content.

Set the image position on the canvas. Center for balanced composition, or corner/edge positions for specific layouts.

Set the mode to print the image on the canvas.

Set the output canvas top margin.

Set the output canvas right margin.

Set the output canvas bottom margin.

Set the output canvas left margin.

Set the output canvas margins. Create white space around the image for framing, borders, or print bleed.

The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.

Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).

Turn on debug logging to troubleshoot conversion issues. Details about the conversion process, including resource loading, rendering steps, and error messages are stored in the debug log. Use this when conversions fail or produce unexpected results. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Get the URL of the debug log for the last conversion.

Get the number of conversion credits available in your account. Use this to monitor your credit usage and implement alerts before running out of credits.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.

Get the number of credits consumed by the last conversion. Use this to track costs per conversion, especially for complex documents or operations that may consume multiple credits.

Get the unique job ID for the conversion. Use this to track conversions in your logs, correlate with debug logs, or reference specific conversions when contacting support.

Get the size of the output document in bytes. Use this to check file sizes before delivery, implement size-based quotas, or optimize storage allocation.

Get the version details including API version, converter version, and client library version. Use this for debugging, logging, or ensuring compatibility when reporting issues.

Tag the conversion with a custom value for tracking and analytics. Use this to categorize conversions by customer ID, document type, or business unit. The tag appears in conversion statistics. A value longer than 32 characters is cut off.

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Specify the User-Agent HTTP header that the client library will use when interacting with the API.

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Specify an HTTP proxy that the API client library will use to connect to the internet.

Specify the number of automatic retries when a 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.