---
updatedAt: 2026-06-12T11:16:53.000Z
agentTools:
  projectIndex: https://apidocs.neuronsinc.com/llms.txt
---

# Get Image Aois

# Return the AOIs associated with an image

### Pre-requisites

You must have an existing image with an associated *media\_id*

Use the media\_id to send the **GET** request to the endpoint `/predict/v2/images/media_id/aois`

### Example of a successful response

If your image contains any AOIs, they should look like this:

```json
{
  "aois": {
    "0c9e8470-1bc4-4e83-b82f-2da605273ab4": {
      "spec": {
        "points": [
          {
            "x": 0.1,
            "y": 0.1
          },
          {
            "x": 0.1,
            "y": 0.3
          },
          {
            "x": 0.4,
            "y": 0.3
          },
          {
            "x": 0.4,
            "y": 0.1
          }
        ],
        "name": "AOI testing",
        "autodetected": false,
        "aoi_type": "product"
      },
      "attentionpercent": 3.0183477327227592,
      "focus_first_two": 4.848102107644081,
      "focus_last_two": 0.6302486639469862,
      "cognitive_percent": 0.9335138729779904,
      "clarity_percent": 6.58610862724483,
      "engagement_percent": 3.8307876538485286,
      "percentage_seen": 17.595168063907714,
      "tot_fix_duration": 0.20957151052745265
    }
  },
  "version": "AOI_IMG_20232809_TIME-SPENT-SCALE-FIX"
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Neurons Customers API v2",
    "version": "2.0.0",
    "description": "Neurons Customers API"
  },
  "paths": {
    "/predict/v2/images/{media_id}/aois": {
      "get": {
        "operationId": "getImageAois",
        "summary": "Get Image Aois",
        "parameters": [
          {
            "in": "path",
            "name": "media_id",
            "schema": {
              "format": "uuid4",
              "title": "Media Id",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AOIResponseListOut"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Content",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "502": {
            "description": "Bad Gateway",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          }
        },
        "description": "# Return the AOIs associated with an image",
        "tags": [
          "Images"
        ],
        "security": [
          {
            "LegacyPredictAPIAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Detail": {
        "properties": {
          "detail": {
            "title": "Detail",
            "type": "string"
          }
        },
        "required": [
          "detail"
        ],
        "title": "Detail",
        "type": "object"
      },
      "AOIResponseListOut": {
        "properties": {
          "aois": {
            "additionalProperties": {
              "$ref": "#/components/schemas/AOIResponseOut"
            },
            "title": "Aois",
            "type": "object"
          },
          "version": {
            "title": "Version",
            "type": "string"
          }
        },
        "required": [
          "aois"
        ],
        "title": "AOIResponseListOut",
        "type": "object"
      },
      "AOIResponseOut": {
        "properties": {
          "spec": {
            "$ref": "#/components/schemas/AOISpec"
          },
          "attentionpercent": {
            "title": "Attentionpercent",
            "type": "number"
          },
          "focus_first_two": {
            "title": "Focus First Two",
            "type": "number"
          },
          "focus_last_two": {
            "title": "Focus Last Two",
            "type": "number"
          },
          "cognitive_percent": {
            "title": "Cognitive Percent",
            "type": "number"
          },
          "clarity_percent": {
            "title": "Clarity Percent",
            "type": "number"
          },
          "engagement_percent": {
            "title": "Engagement Percent",
            "type": "number"
          },
          "percentage_seen": {
            "title": "Percentage Seen",
            "type": "number"
          },
          "tot_fix_duration": {
            "title": "Tot Fix Duration",
            "type": "number"
          },
          "memory_percent": {
            "title": "Memory Percent",
            "type": "number"
          },
          "engagement_frt_percent": {
            "title": "Engagement Frt Percent",
            "type": "number"
          }
        },
        "required": [
          "spec"
        ],
        "title": "AOIResponseOut",
        "type": "object"
      },
      "AOISpec": {
        "properties": {
          "points": {
            "items": {
              "$ref": "#/components/schemas/AOISpecPoint"
            },
            "title": "Points",
            "type": "array"
          },
          "name": {
            "default": "",
            "title": "Name",
            "type": "string"
          },
          "aoi_type": {
            "title": "Aoi Type",
            "enum": [
              "product",
              "branding",
              "headline_text",
              "call_to_action",
              "body_text"
            ],
            "type": "string"
          },
          "autodetected": {
            "default": false,
            "title": "Autodetected",
            "type": "boolean"
          }
        },
        "required": [
          "points"
        ],
        "title": "AOISpec",
        "type": "object"
      },
      "AOISpecPoint": {
        "properties": {
          "x": {
            "title": "X",
            "type": "number"
          },
          "y": {
            "title": "Y",
            "type": "number"
          }
        },
        "required": [
          "x",
          "y"
        ],
        "title": "AOISpecPoint",
        "type": "object"
      }
    },
    "securitySchemes": {
      "LegacyPredictAPIAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.neuronsinc.com"
    }
  ]
}
```