Skip to main content
PUT
/
update-meta
/
screenshot
/
{analysis-id}
curl \
  -X PUT \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -d '{
        "description": "Homepage hero",
        "goal": "Increase sign-ups"
      }' \
  https://api.eyequant.com/v2/update-meta/screenshot/$analysisId

{
  "success": true,
  "meta": {
    "description": "Homepage hero",
    "goal": "Increase sign-ups"
  }
}
Update metadata for an existing image or URL analysis. Use this to add context — a description, goal, target audience, or brand guidelines — that is stored with the analysis and used by generated summaries and recommendations. This endpoint updates metadata only. It does not rerun the analysis or change the maps and scores returned by Get an analysis.
The analysis-id path parameter is the analysis id returned as _internal_exposed_id from Get an analysis — not the top-level id returned when you create an analysis.
​
analysis-id
string
required
The analysis id (_internal_exposed_id from Get an analysis).
​
description
string
What the creative, page, or screen is.
​
goal
string
The user or business outcome the design should support.
​
target_audience
string
The audience the design is intended for.
​
brand_guidelines
string
Brand, messaging, or design constraints to consider.
Supported fields are merged into the existing metadata. Unsupported fields are ignored and returned in ignored_keys. The body must be a JSON object up to 64 KB, with individual string values up to 10,000 characters; deeply nested objects are rejected.
​
success
boolean
Whether the update succeeded.
​
meta
object
The metadata fields accepted by the API.
​
ignored_keys
array
Any unsupported fields that were ignored.
curl \
  -X PUT \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -d '{
        "description": "Homepage hero",
        "goal": "Increase sign-ups"
      }' \
  https://api.eyequant.com/v2/update-meta/screenshot/$analysisId

{
  "success": true,
  "meta": {
    "description": "Homepage hero",
    "goal": "Increase sign-ups"
  }
}