Analyses
Update analysis metadata
Add context such as description, goal, audience, or brand guidelines to an existing analysis.
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
const baseUrl = 'https://api.eyequant.com/v2';
await fetch(`${baseUrl}/update-meta/screenshot/${analysisId}`, {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${apiKey}`,
},
body: JSON.stringify({
description: 'Homepage hero',
goal: 'Increase sign-ups',
}),
});
{
"success": true,
"meta": {
"description": "Homepage hero",
"goal": "Increase sign-ups"
}
}
{
"success": true,
"meta": {
"description": "Homepage hero"
},
"ignored_keys": ["unsupported_field"]
}
{
"error": "Resource not found",
"resource_type": "screenshot",
"resource_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90"
}
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.
Supported fields are merged into the existing metadata. Unsupported fields are ignored and returned in
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.string
required
The analysis id (
_internal_exposed_id from Get an analysis).string
What the creative, page, or screen is.
string
The user or business outcome the design should support.
string
The audience the design is intended for.
string
Brand, messaging, or design constraints to consider.
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.
boolean
Whether the update succeeded.
object
The metadata fields accepted by the API.
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
const baseUrl = 'https://api.eyequant.com/v2';
await fetch(`${baseUrl}/update-meta/screenshot/${analysisId}`, {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${apiKey}`,
},
body: JSON.stringify({
description: 'Homepage hero',
goal: 'Increase sign-ups',
}),
});
{
"success": true,
"meta": {
"description": "Homepage hero",
"goal": "Increase sign-ups"
}
}
{
"success": true,
"meta": {
"description": "Homepage hero"
},
"ignored_keys": ["unsupported_field"]
}
{
"error": "Resource not found",
"resource_type": "screenshot",
"resource_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90"
}
⌘I
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
const baseUrl = 'https://api.eyequant.com/v2';
await fetch(`${baseUrl}/update-meta/screenshot/${analysisId}`, {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${apiKey}`,
},
body: JSON.stringify({
description: 'Homepage hero',
goal: 'Increase sign-ups',
}),
});
{
"success": true,
"meta": {
"description": "Homepage hero",
"goal": "Increase sign-ups"
}
}
{
"success": true,
"meta": {
"description": "Homepage hero"
},
"ignored_keys": ["unsupported_field"]
}
{
"error": "Resource not found",
"resource_type": "screenshot",
"resource_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90"
}