Skip to main content
POST
List conversations

Authorizations

Authorization
string
header
required

Short-lived embed token, minted server-side with your API key via the Mint embed token endpoint. Scoped to one end user and one product.

Path Parameters

product_id
string<uuid>
required

Body

application/json

Required, but empty: scoping is server-side from the token, so there is nothing to filter on.

Response

Successful Response

id
string<uuid>

Pass this to clarityq:open-conversation to show the conversation in the iframe.

description
string | null

The title. Starts as New Chat and is replaced by the generated title a few seconds into the first answer — the embed announces the change via the clarityq:title postMessage, so a live panel never needs to re-fetch for it.

is_title_generating
boolean

true only while the fallback title path is still writing (rare). With the clarityq:title postMessage wired, you can ignore this field.

last_updated
string<date-time>

Sort on this for most-recent-first.

starred
boolean

The user starred it inside the chat.

created_at
string<date-time>