Skip to main content
POST
Submit external feedback
Store an evaluation or feedback payload produced by your own tooling — for example a pipeline that scores ClarityQ’s answers against your reference data. The payload field accepts any JSON and is stored exactly as sent, without validation, so your format can evolve freely without breaking the integration. The optional source, external_id, and conversation_id fields are kept as opaque strings you can use to correlate feedback records with your own systems later.
Example request
Example response

Authorizations

X-API-Key
string
header
required

API key obtained from the ClarityQ dashboard.

Path Parameters

product_id
string<uuid>
required

Body

application/json

An external evaluation/feedback payload, stored as-is.

payload
Payload · object
required

Arbitrary feedback JSON, stored without validation.

source
string
default:unknown

Optional identifier of the sending system, e.g. 'my-eval-pipeline'.

Maximum string length: 200
external_id
string | null

Sender-side identifier for this feedback item, e.g. a question id.

Maximum string length: 500
conversation_id
string | null

Conversation identifier as known to the sender. Stored as an opaque string; it may or may not be a ClarityQ conversation id.

Maximum string length: 500

Response

Successful Response

Acknowledgement that an external feedback payload was stored.

id
string<uuid>
required

Server-assigned id of the stored feedback record.

created_at
string<date-time>
required

When the feedback was stored (RFC3339 UTC).