Summaries & Recommendations
Generate a summary
Trigger asynchronous generation of a written summary for an analysis.
POST
/
analyses
/
summary
/
{analysis-id}
curl \
-X POST \
-H "Authorization: Bearer $apikey" \
https://api.eyequant.com/v2/analyses/summary/$analysisId
const baseUrl = 'https://api.eyequant.com/v2';
const response = await fetch(`${baseUrl}/analyses/summary/${analysisId}`, {
method: 'POST',
headers: { Authorization: `Bearer ${apiKey}` },
});
const summaryStatus = await response.json();
{
"success": true,
"status": "started",
"msg": "Summary generation started"
}
{
"success": false,
"msg": "analysis_not_found"
}
{
"success": false,
"status": "expired",
"msg": "analysis_expired"
}
Trigger asynchronous generation of a written summary for an analysis. After triggering, poll Get a summary until
status is completed. For richer summaries, set context first with Update analysis metadata.
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).boolean
Whether the request was accepted.
string
Generation status:
started or processing.string
Human-readable status message.
curl \
-X POST \
-H "Authorization: Bearer $apikey" \
https://api.eyequant.com/v2/analyses/summary/$analysisId
const baseUrl = 'https://api.eyequant.com/v2';
const response = await fetch(`${baseUrl}/analyses/summary/${analysisId}`, {
method: 'POST',
headers: { Authorization: `Bearer ${apiKey}` },
});
const summaryStatus = await response.json();
{
"success": true,
"status": "started",
"msg": "Summary generation started"
}
{
"success": false,
"msg": "analysis_not_found"
}
{
"success": false,
"status": "expired",
"msg": "analysis_expired"
}
⌘I
curl \
-X POST \
-H "Authorization: Bearer $apikey" \
https://api.eyequant.com/v2/analyses/summary/$analysisId
const baseUrl = 'https://api.eyequant.com/v2';
const response = await fetch(`${baseUrl}/analyses/summary/${analysisId}`, {
method: 'POST',
headers: { Authorization: `Bearer ${apiKey}` },
});
const summaryStatus = await response.json();
{
"success": true,
"status": "started",
"msg": "Summary generation started"
}
{
"success": false,
"msg": "analysis_not_found"
}
{
"success": false,
"status": "expired",
"msg": "analysis_expired"
}