Get Caption Health

GET

/api/canvas/{deal_id}/caption-health

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

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Responses

200

Successful Response

Media type application/json

Example ^generated

example

422

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