Images
List all available images.
GET http://printer/api/v3/images
Query Parameters
| Name | Type | Description |
|---|---|---|
| details | String | "1" or "true" to include details in the response. |
Response
Dictionary of objects.
Get information about an image.
GET http://printer/api/v3/images/{name}/info
Path Parameters
| Name | Type | Description |
|---|---|---|
| name | String | Label name |
Response
| Name | Type | Description |
|---|---|---|
| fileSize | number | Image file size in bytes. |
| format | object | Image format. |
| height | number | Image height in pixels. |
| height_mm | number | Image height in millimeters. |
| intent | string | Render intent. |
| state | string | Image state. One of PROCESSING, READY, ERROR. |
| uid | string | Unique ID of the image. |
| width | number | Image width in pixels. |
| width_mm | number | Image width in millimeters. |
The image format has the following values:
| Name | Type | Description |
|---|---|---|
| alpha | string | Alpha channel. One of NONE, STRAIGHT, PREMULTIPLIED. |
| bitsPerChannel | number | Number of bits per channel. |
| channels | number | Number of channels. |
| colorSpace | string | Optional color space. One of GRAY, RGB, CMYK. |
Get an image.
GET http://printer/api/v3/images/{name}
Path Parameters
| Name | Type | Description |
|---|---|---|
| name | String | Label name |
Response
Image data.
Delete an image.
DELETE http://printer/api/v3/images/{name}
Path Parameters
| Name | Type | Description |
|---|---|---|
| name | String | Image name |
Response
None
Create or replace an image.
PUT http://printer/api/v3/images/{name}
Path Parameters
| Name | Type | Description |
|---|---|---|
| name | String | Image name |
Query Parameters
| Name | Type | Description |
|---|---|---|
| intent | String | Image rendering intent. See Image. |
Headers
| Name | Type | Description |
|---|---|---|
| Content-type | String | Any of application/json (see Image), image/jpeg, image/png or image/tiff. |
Response
None