IIIF Image
A modern API to access high-resolution images from IIIF clients.
Our managed IIIF Image Service is a fully-compliant, Level 2 implementation of the Image API (v3) specification from IIIF. Available to all projects, we also support advanced requirements such as multi-gigabyte files, brand-specific publishing domains, and server customizations for client application requirements.
- File Types: HEIC, JP2, JPEG, PDF, PNG, TIFF
- Maximum Size: 512 MiB (or 4 GiB for Professional plans)
First Steps
This is one of the default services for new projects and is ready to use immediately. To try it out, upload a supported file and use the info.json publishing link it generates.
Publishing
When viewing a supported file, we provide some common links for you to work with.
- info.json — this is the IIIF Image Information resource often needed by IIIF clients and applications. It helps describe: properties of the original image, such as height and width; capabilities of the image server; and some metadata, such as usage rights and related links.
- full/max/0/default.jpg — this is the most basic link for accessing an image. Since this returns the largest available size, be sure to customize it for an optimal size of your application (an official IIIF client or library can help with this).
Server API
If you are generating your own Publishing Links, there are three parts of the path to be aware of: the prefix, identifier, and rest of the path.
- Prefix — this is our standard Path Prefix in the form of
/content/{SERVICE-KEY}/
. For most projects, this will be/content/iiif-image/
. - Identifier — this is our standard Bucket-Object-Ref Parameter in the form of
{BUCKET-KEY};key={ENCODED-OBJECT-KEY}
. For most projects, this looks closer touploads;key={UUID}
. The IIIF Image API also supports an additional argument:page={INTEGER}
(optional; defaultpage=1
) — available for files with embedded, paginated resources (such as PDF). Include the desired page number, starting from 1.
- Rest of the path — see the URI Syntax topic from the official IIIF specification. It should look like:
/info.json
/{REGION}/{SIZE}/{ROTATION}/{QUALITY}.{FORMAT}
Compliance
The official IIIF website offers an Image Validator to help verify compliance of any IIIF Image server. To run a live test against our services, you can use one of the following links. For the broadest validation, use Level 2 + Optional which has all supported, optional features enabled.
Profile | Prefix | info.json | IIIF Image Validator |
---|---|---|---|
Level 2 + Optional | content/iiif-image-v3/ | info.json | Run Live Test |
Level 2 | content/iiif-image-v3-level2/ | info.json | Run Live Test |
Level 1 | content/iiif-image-v3-level1/ | info.json | Run Live Test |
Level 0 | content/iiif-image-v3-level0/ | info.json | Run Live Test |
If you're running the expanded suite of tests, there are two cases which may fail for known reasons:
- We do not currently support the optional PDF format. This is considered an extra feature by the specification, and we do not advertise it to IIIF clients.
- We use request-based cross-origin response headers, but the validator only expects wildcards. That is, we respond with
Access-Control-Allow-Origin: example.com
(stricter, but still spec-compliant and should not affect IIIF clients).