Skip to content

Diagnose citation metadata sources (owner only)

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

Diagnostic endpoint showing why citations may be empty.

Returns raw data availability per section: claim_citations count, inline [^N] ref count, chunk count, combined document status. Owner-only access (not just viewer) since it exposes internal structure.

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": {}
}
]
}