Status of this Document
This version: 2.0.0
Latest stable version: 3.0.0
Introduction
This document is a companion to the IIIF Image API Specification. It defines the set of supported parameters that correspond to different levels of compliance to the API.
Compliance
Three levels of compliance are defined. Level 0 is defined as the minimum set of supported parameters and features that must be implemented to qualify the service as compliant to the IIIF standard. Level 1 is defined as the recommended set of parameters and features to be implemented.
In the tables below “
” indicates that support is required, and “
” indicates that support is optional.
Image Parameters
Region
| Syntax | Feature Name | Level 0 | Level 1 | Level 2 |
|---|---|---|---|---|
full |
|
|
|
|
| x,y,w,h | regionByPx |
|
|
|
| pct:x,y,w,h | regionByPct |
|
|
|
Size
| Syntax | Feature Name | Level 0 | Level 1 | Level 2 |
|---|---|---|---|---|
full |
|
|
|
|
| w,h | sizeByWhListed |
|
|
|
| w, | sizeByW |
|
|
|
| ,h | sizeByH |
|
|
|
| pct:x | sizeByPct |
|
|
|
| w,h | sizeByForcedWh |
|
|
|
| !w,h | sizeByWh |
|
|
|
sizeAboveFull |
|
|
|
Rotation
| Syntax | Feature Name | Level 0 | Level 1 | Level 2 |
|---|---|---|---|---|
0 |
|
|
|
|
90,180,270 |
rotationBy90s |
|
|
|
| arbitrary | rotationArbitrary |
|
|
|
| !n | mirroring |
|
|
|
Quality
| Syntax | Level 0 | Level 1 | Level 2 |
|---|---|---|---|
default |
|
|
|
color |
|
|
(if applicable) |
gray |
|
|
(if applicable) |
bitonal |
|
|
|
Format
| Syntax | Level 0 | Level 1 | Level 2 |
|---|---|---|---|
jpg |
|
|
|
png |
|
|
|
tif |
|
|
|
gif |
|
|
|
pdf |
|
|
|
jp2 |
|
|
|
webp |
|
|
|
HTTP Features
| HTTP Feature | Feature Name | Level 0 | Level 1 | Level 2 |
|---|---|---|---|---|
| base URI redirects | baseUriRedirect |
|
|
|
| CORS | cors |
|
|
|
| json-ld media type | jsonldMediaType |
|
|
|
| profile link header | profileLinkHeader |
|
|
|
| canonical link header | canonicalLinkHeader |
|
|
|
Indicating Compliance
Servers may indicate compliance with by including a header in IIIF responses for images:
Link: <http://iiif.io/api/image/2/level1.json>;rel="profile"
The URIs for the the compliance levels are as follows:
| Level | URI |
|---|---|
| 0 | http://iiif.io/api/image/2/level0.json |
| 1 | http://iiif.io/api/image/2/level1.json |
| 2 | http://iiif.io/api/image/2/level2.json |
A level 0 compliant image server may specify scaleFactors and/or width and height values for tiles in the Image Information response. At Level 0 compliance, a service is only required to deliver images of sizes computed using the scaling factors declared in the Image Information response. If specified they should be interpreted with the following special meanings:
scaleFactors- only the specified scaling factors are supportedwidth,heightwithintiles- clients should request only regions that correspond to output tiles of the specified dimensions
If a client requests a size or region outside these parameters then the image server may reject the request with an error.