v3

latestOpenAPI 3.1.02026-08-044114182.0 KB
Metrics

AI-generated insight paragraph for one topic and run

Synthesises visibility, attribute, and citation data for the topic into a 2–3 sentence actionable insight. Pass runId to read a specific completed run. Returns 404 when the project has no usable run or the topic is unknown.

get/insights/topic

Query parameters

projectIdstring uuid required

Project id. Required on all data endpoints.

runIdstring uuid

Completed prompt run ID. Omit to use the project's latest usable run; use GET /prompts/runs to list historical run IDs.

topicIdstring uuid required
promptAttributesstring

Comma-separated list of attribute filters. Accepts both built-in attributes (e.g. pricing, comparisons) and project-specific custom attributes.

Response

Successful response

insightstring required