Upload And Predict Image

Expected request payload

The request must be sent with a file. The image file can be in the following formats:

png (image/png)
jpg (image/jpg)
jpeg (image/jpeg)

For more information on image upload requirements, please refer to this page. (Note: The upload of PDF files is not supported by the Neurons API).

Example of a successful response

Once the prediction succeeds you get the metrics and the heatmaps.

{
  "media_id": "8d91c929-9a7e-4b29-abc7-3ab0101b5492",
  "name": "Demo image",
  "status": "done",
  "type": "image",
  "aoi_status": "unspecified",
  "results": {
    "heat": "https://files.neuronsinc.com/media_nvai_heat.jpeg",
    "clarity_heat": "https://files.neuronsinc.com/media_ve_clarity_heat.jpeg",
    "engagement_heat": "https://files.neuronsinc.com/media_ve_excitedness_heat.jpeg",
    "cognitive_demand_heat": "https://files.neuronsinc.com/media_nvai_cog_demand_heat.jpeg",
    "fog": "https://files.neuronsinc.com/media_nvai_fog.jpeg",
    "formatted": "https://files.neuronsinc.com/media.png",
    "first_two_heat": "https://files.neuronsinc.com/media_nvai_first2_heat.jpeg",
    "first_two_fog": "https://files.neuronsinc.com/media_nvai_first2_fog.jpeg",
    "last_two_heat": "https://files.neuronsinc.com/media_nvai_last2_heat.jpeg",
    "last_two_fog": "https://files.neuronsinc.com/media_nvai_last2_fog.jpeg",
    "engagement_new_heat": "https://files.neuronsinc.com/media_nvai_engaging_heat.jpeg",
    "memory_heat": "https://files.neuronsinc.com/media_nvai_memory_heat.jpeg",
    "buy_heat": "https://files.neuronsinc.com/media_nvai_buy_heat.jpeg",
    "trustworthy_heat": "https://files.neuronsinc.com/media_nvai_trustworthy_heat.jpeg",
    "annoying_heat": "https://files.neuronsinc.com/media_nvai_annoying_heat.jpeg"
  },
  "metrics": {
    "cognitive_demand": 46.66692841386403,
    "focus": 59.759537435772025,
    "focus_first_two": 67.61034096575193,
    "focus_last_two": 66.91043132486188,
    "clarity": 88.49,
    "engagement": 48.15,
    "engagement_new": 58.3116969754619,
    "memory": 56.13035924973027,
    "buy": 73.59597183042958,
    "trustworthy": 46.642828372217,
    "annoying": 22.09484428167343
  },
  "created_at": "2023-12-05T11:38:09Z",
  "updated_at": "2023-12-05T11:39:18Z"
}

NOTE: The assets will only be available under the URL's for a maximum period of 5 minutes, so make sure to download them before they expire.