Get Caption Health
GET
/api/canvas/{deal_id}/caption-health
const url = 'https://example.com/api/canvas/example/caption-health';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/canvas/example/caption-health \ --header 'Authorization: Bearer <token>'Per-deal image caption health from persisted caption_telemetry.
Reads the caption_telemetry Store artifact written by the caption
enrichment pass during memo generation, and computes an overall caption
success rate plus breakdown by failure mode.
Returns 200 with {"available": false} when no telemetry has been
recorded for this deal (e.g. deal has no images or memo not yet generated).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”deal_id
required
Deal Id
string
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Examplegenerated
exampleValidation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}