DZI API Documentation

Overview

The DZI (Deep Zoom Image) API is a powerful tool designed for stitching Deep Zoom Images into full-sized images. This API provides a simple and flexible interface that supports custom output formats and resizing options.

Endpoint

GET /dzi

Fetches and stitches a DZI image into a full-size image.

Parameters

• url (required): The URL of the DZI image. This parameter must be included in the query.

• format (optional): The desired output format of the image. Defaults to ‘jpeg’. Other supported formats will depend on the API’s capabilities.

• resizeWidth (optional): The width to which the output image should be resized. If not provided, the original image width will be used.

• resizeHeight (optional): The height to which the output image should be resized. If not provided, the original image height will be used.

Limitations

• Max response image size is 10MB.

Example

GET /dzi?url=https://example.com/image.dzi&format=png&resizeWidth=800&resizeHeight=600

This will fetch the DZI image from the provided URL, stitch it together, convert it to PNG format, and resize it to 800x600 pixels.

Responses

• 200: Successful operation. The response will be the stitched image.

Error Codes

The API uses standard HTTP status codes to indicate the success or failure of a request. The 2xx series of response codes indicate a success, 4xx indicates an error from the client-side, and a 5xx error indicates a server-side error.

Conclusion

The DZI API is a simple, flexible, and powerful tool for working with Deep Zoom Images. It saves you the complex and time-consuming task of manually stitching together DZI images, providing a seamless interface for generating high-quality, full-sized images from DZI files.