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)
webp (image/webp)

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",
    "intent_heat": "https://files.neuronsinc.com/media_nvai_buy_heat.jpeg",
    "trust_heat": "https://files.neuronsinc.com/media_nvai_trustworthy_heat.jpeg",
    "avoidance_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,
    "intent": 73.59597183042958,
    "trust": 46.642828372217,
    "avoidance": 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.

Image prediction results

Below there's a brief explanation of each field in the image prediction results:

media_id: The unique identifier, which can be used to query the media.
name: The name of the image file.
status: The prediction status. If status is done then results should be visible in the response.
type: The type of media (image or video).

The heat maps are stored as image assets (with an expiry, as explained above), and links can be find under results:

heat: This is the attention heat map.
clarity_heat: This is the heat map for clarity.
engagement_heat: This is the engagement heat map.
fog: This is the attention fog map.
formatted: This is the original image (no heat map).
first_two_heat: This is heat map shows what draws attention in the first two seconds.
first_two_fog: This is fog map shows what draws attention in the first two seconds.
last_two_heat: This is heat map shows what draws attention in the final two seconds.
last_two_fog: This is fog map shows what draws attention in the final two seconds.
engagement_new_heat: The heat map for the brand new engagement metric.
memory_heat: The heat map for the brand new memory metric.
intent_heat: The heat map for the brand new intent to intent metric.
trust_heat: The heat map for the brand new trust metric.
avoidance_heat: The heat map for the brand new avoidance metric.

Metrics (find out what each metric means in this article):

cognitive_demand: The value for cognitive demand (in percentage).
focus: The value for total attention (in percentage).
focus_first_two: The value for attention during the first two seconds (in percentage).
focus_last_two: The value for attention during the final two seconds (in percentage).
clarity: The value for clarity (in percentage).
engagement: The value for engagement (in percentage).
engagement_new: The value for the brand new engagement metric (in percentage).
memory: The value for the brand new memory metric (in percentage).
intent: The value for the brand new intent metric (in percentage). Based on association words like Explore, Consider, Choose, Try, Recommend and Buy, this behavioural metric provides a gauge for how likely the viewers of the creative are to act upon the ads message. It signals the consumer’s likelihood to engage, recommend or purchase. The Intent metric translates into strong consideration, conversion or advocacy as an initial reaction to the creative.
trust: The value for the brand new trust metric (in percentage). Based on association words like Trustworthy, Honest and Sincere this cognitive metric gives an assessment of the level of trust built by the creative. As the other FRT Metrics (like Engagement) it measures gut reaction of to what extend the asset fosters trust and a sense of authentic message. This can drive brand equity, retention and loyalty as well as influencing consideration.
avoidance: The value for the brand new avoidance metric (in percentage). Based on the association words Boring and Annoying this metric shows for the first time a gut reaction of negative sentiment to the creative. It measures the extent to which a creative creates disinterest, discontent or friction. At the core of the metric is the assessment of avoidance-related motivation and behaviour and is a strong indicator of dropoff, negative association and acts against brand building and lift.