Transformation Debug Mode

You can get detailed information back about successful and failed requests. This can be useful if something you think should work isn't working. It is also useful to provide this information to Filestack Support if you need to contact us.

Note: The maximum accepted image size is 100,000,000 pixels. An image with this many pixels could have width and height combinations like 10,000 x 10,000 or 5,000 x 20,000, etc. There is also a file size restriction. Filestack will not convert an image that is larger than 256mb. Please contact us if you require the ability to process larger files than our current limits.

Debug Task URL Formats:
https://process.filestackapi.com/debug/[conversion task]=[options]/Filestack_FileLink_Handle
or
https://process.filestackapi.com/<API_KEY>/debug/[conversion task]=[options]/File_URL
debug
String

Root task cannot be abbreviated

Returns detailed information about the transformation request. Debug requires no additional parameters. It is simply called like this: debug.

Debug Examples

By default users will receive a message about what is wrong with their requests, here the word height is misspelled:

This will result in the following message to a user:

invalid parameter `heigt` for `resize` task
        

Users can receive a more detailed message about the failure by appending the debug parameter before the conversion task:

This more detailed message comes in the form of a JSON object like this:

{
  "apikey": "AhTgLagciQByzXpFGRI0Az",
  "status": {
    "message": "validation error: invalid parameter `heigt` for `resize` task",
    "http_code": 400
  },
  "start_time": "2015-11-02T17:07:52.015562827Z",
  "processing_time": "4.390643ms",
  "source": {
    "url": "https://d1wtqaffaaj63z.cloudfront.net/images/parade_helmet.jpg",
    "mimetype": "image/jpeg",
    "size": 67106
  },
  "task_uri": "resize=width:501,heigt:501/detect_faces=filter:40",
  "debug": true,
  "chain": null
}
        

If the request is okay (no spelling or syntax errors), but there is still a failure the user can see why:

Here the detect faces task has failed to find any faces in this picture of a helmet (which is the expected behavior):

{
  "apikey": "AhTgLagciQByzXpFGRI0Az",
  "status": {
    "message": "conv20 provider error: No faces found in image (idx 0)",
    "http_code": 500
  },
  "start_time": "2015-11-03T16:37:36.086011364Z",
  "processing_time": "817.139296ms",
  "source": {
    "url": "https://d1wtqaffaaj63z.cloudfront.net/images/parade_helmet.jpg",
    "mimetype": "image/jpeg",
    "size": 67106
  },
  "task_uri": "resize=width:501,height:501/detect_faces",
  "debug": true,
  "chain": [
    {
      "provider": "conv20",
      "tasks": [
        {
          "name": "resize",
          "params": {
            "align": "center",
            "fit": "clip",
            "height": 501,
            "width": 501
          }
        },
        {
          "name": "detect_faces",
          "params": {
            "color": "#000000FF",
            "maxsize": 0.35,
            "minsize": 0.35
          }
        }
      ],
      "status": {
        "message": "conv20 provider error: No faces found in image (idx 0)",
        "http_code": 500
      },
      "start_time": "2015-11-03T16:37:36.120787701Z",
      "processing_time": "782.360884ms"
    }
  ]
}
        

Debug information is also available for successful requests:

Here is the JSON object for the successful request:

{
  "apikey": "AhTgLagciQByzXpFGRI0Az",
  "status": {
    "message": "-",
    "http_code": 200
  },
  "start_time": "2015-11-02T17:27:05.559042047Z",
  "processing_time": "1.227603116s",
  "source": {
    "url": "https://d1wtqaffaaj63z.cloudfront.net/images/NY_199_E_of_Hammertown_2014.jpg",
    "mimetype": "image/jpeg",
    "size": 1033409
  },
  "task_uri": "resize=width:500,height:500,fit:crop",
  "debug": true,
  "chain": [
    {
      "provider": "conv20",
      "tasks": [
        {
          "name": "resize",
          "params": {
            "align": "center",
            "fit": "crop",
            "height": 500,
            "width": 500
          }
        }
      ],
      "status": {
        "message": "-",
        "http_code": 200
      },
      "start_time": "2015-11-02T17:27:05.572391519Z",
      "processing_time": "1.214249955s",
      "size": 344078,
      "mimetype": "image/jpeg"
    }
  ]
}