Skip to content

Get Retrieval Quality

GET
/api/canvas/{deal_id}/retrieval-quality
curl --request GET \
--url https://example.com/api/canvas/example/retrieval-quality \
--header 'Authorization: Bearer <token>'

Get retrieval quality summary for a deal.

Returns per-section retrieval grades, source diversity metrics, and overall deal quality assessment. Data comes from stored pipeline telemetry — no LLM calls.

Returns empty scores if no retrieval data is available (e.g., new deal without completed pipeline run).

deal_id
required
Deal Id
string

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}