ioio.tv APIs

# List Single Image

API call format

GET /images/{guid}              //Use token autorization
GET /images/private/{guid}      //Use Api Key

Description

List all images

Precondition:

  • Authorization token/Api key is needed.
  • Mandatory elements:
  • Optional elements:
    • w - Desired width of the image in pixels. Example format: 320
    • h - Desired height of the image in pixels. Example format: 160
    • withAIMeta - Return image with its AI meta data
    • d - Desired dimension of the image in pixels. Example format: 320x160

Postcondition

  • On success response code should be 200
  • On success JSON formatted details for the image is returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/images/<image_guid>                //use GET /images to find a specific image guid
[Request] GET https://<base_api_url>/images/private/<image_guid>        //use GET /images to find a specific image guid
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
  "status": true,
  "data": {
    "guid": "<image_guid>",
    "originalFileName": "<file_name>.png",
    "meta": {},
    "width": 1916,
    "height": 922,
    "format": "png",
	"srcPath": "<Image path with the bucket>/image/<image_guid>/<image_guid>.png",
	"cdnPath": "https://<Image full path through cdn>/images/image/<image_guid>.png",
    "imageMeta": {
      "depth": "uchar",
      "size": 128777,
      "channels": 3,
      "density": 96,
      "isProgressive": false,
      "format": "png",
      "width": 1916,
      "hasProfile": false,
      "space": "srgb",
      "hasAlpha": false,
      "height": 922
    },
    "hasAIMeta": false
  }
}

← Fetch Single Image →