Skip to main content
GET
/
api
/
v1
/
products
/
{product_id}
/
conversations
/
{conversation_id}
/
summary
Get conversation summary
curl --request GET \
  --url https://api.clarityq.ai/api/v1/products/{product_id}/conversations/{conversation_id}/summary \
  --header 'X-API-Key: <api-key>'
{
  "assets": [
    {
      "asset_type": "SQL",
      "data": [
        {
          "query": "<string>",
          "title": "",
          "result_count": 123,
          "result_rows": [
            {}
          ],
          "error": "<string>"
        }
      ]
    }
  ],
  "summary": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarityq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key obtained from the ClarityQ dashboard.

Path Parameters

​
product_id
string<uuid>
required
​
conversation_id
string<uuid>
required

Response

Successful Response

Summary of a conversation's last assistant response.

​
assets
SqlAsset · object[]

Assets extracted from the last assistant message, grouped by type.

​
summary
string | null

Text summary from the assistant (last text part of the message).